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 'obvious fix' rule #53

Merged
merged 1 commit into from
Jan 13, 2017
Merged
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
42 changes: 42 additions & 0 deletions docs/project-documentation/contributing-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,48 @@ 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.

Every commit that does not meet the criteria for an [obvious fix](#obvious-fix),
must have a `Signed-off-by` line.

### Obvious Fix

Very small contributions such as fixing spelling errors, where the contents is
small enough to not be considered intellectual property, can be submitted without
a DCO sign-off.

Whenever you invoke the "obvious fix" rule, please say so in your commit message:

```
Fixed typo in README.

Obvious fix
```

An obvious fix is a pull request that does not contain creative work. We rely on
your judgment to determine what is "obvious"; if you are not sure, just ask.

As a rule of thumb, changes are obvious fixes if they do not introduce any new
functionality or creative thinking. Some examples include the following:

* Spelling/grammar fixes, correcting typos,
* Cleaning up comments in the code,
* Changes to white space or formatting,
* Changes to 'metadata' files like makefile, .config, .gitignore, etc.,
* Changes in build or installation scripts,
* Re-ordering contents within a source file,
* Moving source files from one directory to another, with no changes in the code,
* Breaking a source file into multiple files, or consolidating multiple source
files into one, with no change in code behavior,
* Changes to words or phrases isolated from their context.

Things that would still require a DCO sign-off before submitting would likely
include

* Any of the above actions that result in a change of functionality,
* A new feature,
* A translation,
* Extensive or creative comments.

## 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