This repository has been archived by the owner on Nov 1, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly
- Loading branch information
Daniel Holbach
committed
Aug 28, 2018
1 parent
fcc1cc9
commit 4e11009
Showing
2 changed files
with
117 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# How to Contribute | ||
|
||
Flux is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub | ||
pull requests. This document outlines some of the conventions on development | ||
workflow, commit message formatting, contact points and other resources to make | ||
it easier to get your contribution accepted. | ||
|
||
We gratefully welcome improvements to documentation as well as to code. | ||
|
||
# Certificate of Origin | ||
|
||
By contributing to this project you agree to the Developer Certificate of | ||
Origin (DCO). This document was created by the Linux Kernel community and is a | ||
simple statement that you, as a contributor, have the legal right to make the | ||
contribution. No action from you is required, but it's a good idea to see the | ||
[DCO](DCO) file for details before you start contributing code to Flux. | ||
|
||
# Chat | ||
|
||
The project uses Slack: To join the conversation, simply join the | ||
[Weave community](https://slack.weave.works/) Slack workspace and use the | ||
[#flux](https://weave-community.slack.com/messages/flux/) channel. | ||
|
||
## Getting Started | ||
|
||
- Fork the repository on GitHub | ||
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help | ||
- If you want to contribute as a developer, continue reading this document for further instructions | ||
- Play with the project, submit bugs, submit pull requests! | ||
|
||
## Contribution workflow | ||
|
||
This is a rough outline of how to prepare a contribution: | ||
|
||
- Create a topic branch from where you want to base your work (usually branched from master). | ||
- Make commits of logical units. | ||
- Make sure your commit messages are in the proper format (see below). | ||
- Push your changes to a topic branch in your fork of the repository. | ||
- If you changed code: | ||
- add automated tests to cover your changes | ||
- Submit a pull request to the original repository. | ||
|
||
## How to build and run the project | ||
|
||
Refer to the [building doc](site/building.md) to find out how to build from | ||
source. | ||
|
||
## How to run the test suite | ||
|
||
You can run the linting and unit tests by simply doing | ||
|
||
```bash | ||
make test | ||
``` | ||
|
||
# Acceptance policy | ||
|
||
These things will make a PR more likely to be accepted: | ||
|
||
* a well-described requirement | ||
* tests for new code | ||
* tests for old code! | ||
* new code and tests follow the conventions in old code and tests | ||
* a good commit message (see below) | ||
|
||
In general, we will merge a PR once two maintainers have endorsed it. | ||
Trivial changes (e.g., corrections to spelling) may get waved through. | ||
For substantial changes, more people may become involved, and you might | ||
get asked to resubmit the PR or divide the changes into more than one PR. | ||
|
||
### Format of the Commit Message | ||
|
||
For Flux we prefer the following rules for good commit messages: | ||
|
||
- Limit the subject to 50 characters and write as the continuation | ||
of the sentence "If applied, this commit will ..." | ||
- Explain what and why in the body, if more than a trivial change; | ||
wrap it at 72 characters. | ||
|
||
The [following article](https://chris.beams.io/posts/git-commit/#seven-rules) | ||
has some more helpful advice on documenting your work. |
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. |