Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
248e53a
commit 8de4f3f
Showing
1 changed file
with
10 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,14 @@ | ||
We'll be glad to accept patches and contributions to the project. There are | ||
just few guidelines we ask to follow. | ||
|
||
Contribution License Agreement | ||
============================== | ||
# Contributing | ||
|
||
If you want/plan to contribute, we ask you to sign a | ||
[CLA](https://cla.microsoft.com/) (Contribution License Agreement). | ||
A friendly bot will remind you about it when you submit a pull-request. | ||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
|
||
This project has adopted the | ||
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct). | ||
For more information see the | ||
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq) | ||
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with | ||
any additional questions or comments. | ||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
||
Submitting a contribution | ||
========================= | ||
|
||
It's generally best to start by | ||
[opening a new issue](https://help.github.com/articles/creating-an-issue) | ||
describing the work you intend to submit. Even for minor tasks, it's helpful | ||
to know what contributors are working on. Please mention in the initial issue | ||
that you are planning to work on it, so that it can be assigned to you. | ||
|
||
Follow the usual GitHub flow process of | ||
[forking the project](https://help.github.com/articles/fork-a-repo), | ||
and setup a new branch to work in. Each group of changes should be done in | ||
separate branches, in order to ensure that a pull request only | ||
includes the changes related to one issue. | ||
|
||
Any significant change should almost always be accompanied by tests. Look at | ||
the existing tests to see the testing approach and style used. | ||
|
||
Follow the project coding style, to ensure consistency and quick code reviews. | ||
For more information about the development workflow, have a look at | ||
[the development notes](DEVELOPMENT.md). | ||
|
||
Do your best to have clear commit messages for each change, in order to keep | ||
consistency throughout the project. Reference the issue number (#num). A good | ||
commit message serves at least these purposes: | ||
* Speed up the pull request review process | ||
* Help future developers to understand the purpose of your code | ||
* Help the maintainer write release notes | ||
|
||
One-line messages are fine for small changes, but bigger changes should look | ||
like this: | ||
``` | ||
$ git commit -m "A brief summary of the commit | ||
> | ||
> A paragraph describing what changed and its impact." | ||
``` | ||
|
||
Finally, push the commits to your fork, submit a pull request, wait for the | ||
automated feedback from Travis CI, and follow the code review progress. The | ||
team might ask for some | ||
[changes](https://help.github.com/articles/committing-changes-to-a-pull-request-branch-created-from-a-fork) | ||
before merging the pull request. | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |