Contributing to Blue Spire. Projects
We'd love for you to contribute to our source code and to make our projects even better than they are today! Here are the guidelines we'd like you to follow:
- Code of Conduct
- Questions or Problems
- Issues and Bugs
- Feature Requests
- Submission Guidelines
- Coding Rules
- Commit Message Guidelines
- Signing the CLA
As contributors and maintainers of Blue Spire projects (DurandalJS, Aurelia, etc.), we pledge to respect every contributor.
Communication through any channels under the control of Blue Spire must always be constructive and professional.
We promise to extend courtesy and respect to everyone involved in these projects. We expect anyone contributing to Blue Spire projects to do the same.
If any member of the community violates this code of conduct, the maintainers of Blue Spire projects may take action as deemed appropriate.
If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at firstname.lastname@example.org.
If you have questions about how to use any Durandal Inc. project library, please direct these to the Gitter Channels or StackOverflow.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to the appropriate GitHub Repository. Even better you can submit a Pull Request with a fix.
Please see the Submission Guidelines below.
You can request a new feature by submitting an issue to the appropriate GitHub Repository. If you would like to implement a new feature then consider what kind of change it is:
- Major Changes that you wish to contribute to the project should be discussed first in our Gitter Channels so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
- Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.
Submitting an Issue
Before you submit your issue, search the archive. It may be that it was already addressed. If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
- Overview of the Issue - If an error is being thrown, a non-minified stack trace helps.
- Motivation or Use Case - Explain why this is a bug for you.
- Library Name and Version(s) - Please indicate if it is a regression bug.
- Browsers and Operating System - Is this a problem with all browsers or only IE?
- Reproduce the Error - If possible, provide a live example (using Plunker or JSFiddle). Minimally, please provide an unambiguous set of steps to reproduce the issue.
- Related Issues - Has a similar issue been reported before?
- Suggest a Fix - If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit).
Submitting a Pull Request
Before you submit your pull request consider the following guidelines:
Search the appropriate GitHub Repository for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Please sign our Contributor License Agreement (CLA) before sending Pull Requests. We cannot accept code without this.
Make your changes in a new git branch:
git checkout -b my-fix-branch master
Create your patch, including appropriate test cases.
Follow our Coding Rules.
Run the full test suite and ensure that all tests pass.
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to the commit message conventions is required because release notes are automatically generated from these messages.
git commit -a
Note: The optional commit
-acommand line option will automatically "add" and "rm" edited files.
Build your changes locally to ensure all the tests pass
Push your branch to GitHub:
git push origin my-fix-branch
In GitHub, send a Pull Request to the master branch.
If we suggest changes then:
- Make the required updates.
- Re-run the test suite to ensure tests are still passing.
- Rebase your branch and force push to your GitHub Repository (this will update your Pull Request):
git rebase master -i git push -f
After Your Pull Request is Merged
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-fix-branch
Check out the master branch:
git checkout master -f
Delete the local branch:
git branch -D my-fix-branch
Update your master with the latest upstream version:
git pull --ff upstream master
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs.
- All public API methods must be documented. To see how we document our APIs, please check out the existing docs.
- Instead of complex inheritance hierarchies, we prefer simple objects.
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.
Commit Message Format
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer>
The subject line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
Please use one of the following:
- feat: A new feature
- fix: A bug fix
- doc: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The scope could be anything specifying the location of the commit change. For example
The subject contains a succinct description of the change:
- Use the imperative, present tense: "change" not "changed" nor "changes".
- Don't capitalize the first letter.
- Do not add a dot (.) at the end.
The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise! You can sign the CLA here.
Note: This document is based on the AngularJS Contributor doc. Thanks to that team for putting it together.