-
-
Notifications
You must be signed in to change notification settings - Fork 176
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Developer Certificate of Origin documentation (#52)
- Loading branch information
1 parent
1edd434
commit 0d4024a
Showing
4 changed files
with
17 additions
and
16 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file removed
BIN
-24.7 KB
docs/CLA/nano-Framework-Individual-Contributor-License-Agreement.pdf
Binary file not shown.
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 |
---|---|---|
|
@@ -16,18 +16,15 @@ Make a quality change. Consider and document (preferably with tests) as many usa | |
|
||
There are several issues to keep in mind when making a change. | ||
|
||
<!--Managed Code Compatibility | ||
-------------------------- | ||
Please review [Breaking Changes](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-changes.md) before making changes to managed code. Please pay the most attention to changes that affect the [Public Contract](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-changes.md#bucket-1-public-contract).--> | ||
|
||
## Typos | ||
|
||
Typos are embarrassing! We will accept most PRs that fix typos. In order to make it easier to review your PR, please focus on a given component with your fixes or on one type of typo across the entire repository. If it's going to take >30 mins to review your PR, then we will probably ask you to chunk it up. | ||
|
||
## Coding Style Changes | ||
|
||
We would like to have **nano Framework** in full conformance with the style guidelines described here [C/C++ Coding Style](../coding-guidelines/cxx-coding-style.md) and here [C# Coding Style](../coding-guidelines/cs-coding-style.md). We plan to do that with tooling, in a holistic way. In the meantime, please: | ||
|
||
* **DO NOT** send PRs for style changes. | ||
* **DO NOT** send PRs for style changes. | ||
* **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. | ||
|
||
## Commit Messages | ||
|
@@ -47,12 +44,25 @@ below. | |
Fix #42 | ||
``` | ||
|
||
Also do your best to factor commits appropriately, i.e not too large with unrelated | ||
Also do your best to factor commits appropriately, i.e. not too large with unrelated | ||
things in the same commit, and not too small with the same small change applied N | ||
times in N different commits. If there was some accidental reformatting or whitespace | ||
changes during the course of your commits, please rebase them away before submitting | ||
the PR. | ||
|
||
## Developer Certificate of Origin | ||
|
||
We have adopted the [Developer Certificate of Origin](http://developercertificate.org/) | ||
(DCO) and request the developer to include a `Signed-off-by` line in the commit | ||
message to indicate they understand and agree to the DCO: | ||
|
||
``` | ||
Signed-off-by: Joe Smith <[email protected]> | ||
``` | ||
|
||
The project requires that the name used is your real name. Neither anonymous | ||
contributions nor those utilizing pseudonyms will be accepted. | ||
|
||
## PR Feedback | ||
|
||
**nano Framework** team and community members will provide feedback on your change. Community feedback is highly valued. You will often see the absence of team feedback if the community has already provided good review feedback. | ||
|
@@ -80,6 +90,7 @@ We use and recommend the following workflow: | |
- Branches are useful since they isolate your changes from incoming changes from upstream. They also enable you to create multiple PRs from the same fork. | ||
4. Make and commit your changes. | ||
- Please follow our [Commit Messages](contributing-workflow.md#commit-messages) guidance. | ||
- Include `Signed-off-by` line, e.g. `git commit -s` | ||
5. Add new tests corresponding to your change, if applicable. | ||
6. Build the repository with your changes. | ||
- Make sure that the builds are clean. | ||
|
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