Browse Source

docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly

Daniel Holbach 1 year ago
parent
commit
4e11009a0b
2 changed files with 117 additions and 0 deletions
  1. 81
    0
      CONTRIBUTING.md
  2. 36
    0
      DCO

+ 81
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,81 @@
1
+# How to Contribute
2
+
3
+Flux is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub
4
+pull requests. This document outlines some of the conventions on development
5
+workflow, commit message formatting, contact points and other resources to make
6
+it easier to get your contribution accepted.
7
+
8
+We gratefully welcome improvements to documentation as well as to code.
9
+
10
+# Certificate of Origin
11
+
12
+By contributing to this project you agree to the Developer Certificate of
13
+Origin (DCO). This document was created by the Linux Kernel community and is a
14
+simple statement that you, as a contributor, have the legal right to make the
15
+contribution. No action from you is required, but it's a good idea to see the
16
+[DCO](DCO) file for details before you start contributing code to Flux.
17
+
18
+# Chat
19
+
20
+The project uses Slack: To join the conversation, simply join the
21
+[Weave community](https://slack.weave.works/) Slack workspace and use the
22
+[#flux](https://weave-community.slack.com/messages/flux/) channel.
23
+
24
+## Getting Started
25
+
26
+- Fork the repository on GitHub
27
+- Read the [README](README.md) for getting started as a user and learn how/where to ask for help 
28
+- If you want to contribute as a developer, continue reading this document for further instructions
29
+- Play with the project, submit bugs, submit pull requests!
30
+
31
+## Contribution workflow
32
+
33
+This is a rough outline of how to prepare a contribution:
34
+
35
+- Create a topic branch from where you want to base your work (usually branched from master).
36
+- Make commits of logical units.
37
+- Make sure your commit messages are in the proper format (see below).
38
+- Push your changes to a topic branch in your fork of the repository.
39
+- If you changed code:
40
+   - add automated tests to cover your changes
41
+- Submit a pull request to the original repository.
42
+
43
+## How to build and run the project
44
+
45
+Refer to the [building doc](site/building.md) to find out how to build from
46
+source.
47
+
48
+## How to run the test suite
49
+
50
+You can run the linting and unit tests by simply doing
51
+
52
+```bash
53
+make test
54
+```
55
+
56
+# Acceptance policy
57
+
58
+These things will make a PR more likely to be accepted:
59
+
60
+ * a well-described requirement
61
+ * tests for new code
62
+ * tests for old code!
63
+ * new code and tests follow the conventions in old code and tests
64
+ * a good commit message (see below)
65
+
66
+In general, we will merge a PR once two maintainers have endorsed it.
67
+Trivial changes (e.g., corrections to spelling) may get waved through.
68
+For substantial changes, more people may become involved, and you might
69
+get asked to resubmit the PR or divide the changes into more than one PR.
70
+
71
+### Format of the Commit Message
72
+
73
+For Flux we prefer the following rules for good commit messages:
74
+
75
+- Limit the subject to 50 characters and write as the continuation
76
+  of the sentence "If applied, this commit will ..."
77
+- Explain what and why in the body, if more than a trivial change;
78
+  wrap it at 72 characters.
79
+
80
+The [following article](https://chris.beams.io/posts/git-commit/#seven-rules)
81
+has some more helpful advice on documenting your work.

+ 36
- 0
DCO View File

@@ -0,0 +1,36 @@
1
+Developer Certificate of Origin
2
+Version 1.1
3
+
4
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5
+660 York Street, Suite 102,
6
+San Francisco, CA 94110 USA
7
+
8
+Everyone is permitted to copy and distribute verbatim copies of this
9
+license document, but changing it is not allowed.
10
+
11
+
12
+Developer's Certificate of Origin 1.1
13
+
14
+By making a contribution to this project, I certify that:
15
+
16
+(a) The contribution was created in whole or in part by me and I
17
+    have the right to submit it under the open source license
18
+    indicated in the file; or
19
+
20
+(b) The contribution is based upon previous work that, to the best
21
+    of my knowledge, is covered under an appropriate open source
22
+    license and I have the right under that license to submit that
23
+    work with modifications, whether created in whole or in part
24
+    by me, under the same open source license (unless I am
25
+    permitted to submit under a different license), as indicated
26
+    in the file; or
27
+
28
+(c) The contribution was provided directly to me by some other
29
+    person who certified (a), (b) or (c) and I have not modified
30
+    it.
31
+
32
+(d) I understand and agree that this project and the contribution
33
+    are public and that a record of the contribution (including all
34
+    personal information I submit with it, including my sign-off) is
35
+    maintained indefinitely and may be redistributed consistent with
36
+    this project or the open source license(s) involved.

Loading…
Cancel
Save