We accept contributions of every kind: documentation, code, artwork. Any help is greatly appreciated. This document contains everything needed to get started with your first contribution.
The Developer Guide can help you set up your developement environment.
We keep the source code on github and take contributions through github Pull Requests.
For smaller patches and bug fixes just go ahead and either report an issue or submit a merge request.
It is usually a good idea to discuss major changes with the developers, this will help us determine whether the contribution would be a good fit for the project and if it is likely to be accepted. There's nothing worse than seeing your hard work being rejected because it falls outside of the scope of the project.
Make sure your editor respects the EditorConfig configuration file we put at the root of the repository.
We follow GitHub Flow as our git workflow of choice which boils down to:
- The
masterbranch is always stable and deployable. - To work on something new, branch off
masterand give the new branch a descriptive name (e.g.:sort-packages-by-name,issue-32, etc). - Regularly rebase that branch against
masterand push your work to a branch with the same name on the server. - When you need feedback, help or think you are ready, submit a Pull Request.
- Once the branch has been merged (or rebased) into
master, delete it from both your local and remote repository.
We enforce the AnguarJS Git Commit Guidelines with pre-commit hooks that evaluate your commit message format. Formatted commit messages are easier to read, and parsed by semantic-release to automatically publish changes with valid semver tags.
![Help][ocitcon-question] Unfamiliar with the Angular commit message format?
Try a CLI tool like Commitizen, which presents a step-by-step wizard to create perfect commit messages (till you get the hang of it).
Additionally, you don't need to add entries to the CHANGELOG.md file, this is our responsibility.