Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

70 lines (54 loc) · 3.04 KB
Raw

Contributing to authmosphere

Thank you for your interest in making this project even better and more awesome. Your contributions are highly welcome.

There are multiple ways of getting involved:

Below are a few guidelines we would like you to follow. If you need help, please open a github Issue in this project. If you work at Zalando reach out to us at Team Graviton.

Report a bug

Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an issue reporting the same problem does not already exist. If there is an such an issue, you may add your information as a comment.

To report a new bug, open an issue that summarizes the bug and set the label to "bug".

If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section Contribute Code.

If it is a security relevant bug, please follow the Security instructions.

Suggest a Feature

To request a new feature, open an issue and summarize the desired functionality and its use case. Set the issue label to "feature".

Contribute code

This is a rough outline of what the workflow for code contributions looks like:

  • Check the list of open issues. Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases.
  • Fork the repository
  • Create a feature branch. Best practise for naming:
<branch name> = <Github issue ticket number>-<component-name>-<whatever-describes-the-ticket>
  • Make commits of logical units.
  • Lint your contribution by npm run tslint before commit
  • Write good commit messages (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request
  • Your pull request must receive a 👍 from two maintainers.

Thanks for your contributions!

Commit messages

  • Commit message format (use editor for comfortable multi line):
feat(feature): commit message
^--^^-------^  ^------------^
|     |             |
|     |             +-> Summary
|     |
|     +-> scope
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
<blank line>
close #<ticket number>

Additional information on the format: Type description (by Angular.js project) Angular.js commit guidelines

  • Finally: Create pull request. When creating a pull request, its comment should reference the corresponding issue id.

Have fun and enjoy hacking!