Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Developer Certificate of Origin documentation #52

Merged
merged 1 commit into from
Jan 11, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
23 changes: 17 additions & 6 deletions docs/project-documentation/contributing-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
10 changes: 0 additions & 10 deletions docs/project-documentation/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,3 @@ The following rules must be followed for PRs that include files from another pro
There are many good algorithms implemented in other languages that would benefit the **nano Framework** project. The rules for porting a Java file to C# , for example, are the same as would be used for copying the same file, as described above.

[Clean-room](https://en.wikipedia.org/wiki/Clean_room_design) implementations of existing algorithms that are not permissively licensed will generally not be accepted. If you want to create or nominate such an implementation, please create an issue to discuss the idea.

### Contributor License Agreement

You must sign a Contribution License Agreement (CLA) before your PR will be merged. This is a one-time requirement for **nano Framework** projects. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.

There are two agreements, one for individual contributions and other for entity contributions (this one is applicable when you are working on nano Framework at your work place during your work time which, technically, is owned by your employer).
The individual agreement: [nano-Framework-Individual-Contributor-License-Agreement.pdf](../CLA/nano-Framework-Individual-Contributor-License-Agreement.pdf)
The entity agreement: [nano-Framework-Entity-Contributor-License-Agreement.pdf](../CLA/nano-Framework-Entity-Contributor-License-Agreement.pdf)

You don't have to do this up-front. You can simply clone, fork, and submit your pull-request as usual. When your pull-request is created, it is classified by a CLA bot. If the change is trivial (e.g. you just fixed a typo), then the PR is labelled with `cla-not-required`. Otherwise it's classified as `cla-required`. Once you signed a CLA, the current and all future pull-requests will be labelled as `cla-signed`.