You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-30Lines changed: 9 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,6 @@ Thanks for taking the time to consider contributing! We very much appreciate you
6
6
7
7
Before you begin contributing to our project, it'll be a good idea to ensure you've satisfied the below pre-requisites.
8
8
9
-
### Developer Certificate of Origin (DCO)
10
-
11
-
To accept your contributions for any kind of patch, you'll want to:
12
-
1. Understand what a Developer Certificate of Origin is. See [this](https://wiki.linuxfoundation.org/dco) guide.
13
-
2. Read and agree to the [terms](https://developercertificate.org) of the Developer Certificate of Origin.
14
-
3. Remember to add your Sign-Off for each patch contribution you submit to our project via either:
15
-
1. By using the `-s` flag if using Git. See [these](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) instructions.
16
-
2. By including the following text in your patch contributions (i.e. pull requests)
17
-
```
18
-
Signed-off-by: Full Name <email>
19
-
```
20
-
21
-
Reviewers reviewing your patch will look for the sign-off before deciding to accept your contribution.
22
-
23
9
### License
24
10
25
11
Our project has our licensing terms, including rules governing redistribution, documented in our [LICENSE](LICENSE) file. Please take a look at that file and ensure you understand the terms. This will impact how we, or others, use your contributions.
@@ -28,10 +14,6 @@ Our project has our licensing terms, including rules governing redistribution, d
28
14
29
15
Our Code of Conduct helps facilitate a positive interaction environment for everyone involved with the team, and provides guidance on what to do if you experience problematic behavior. Read more in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and make sure you agree to its terms.
30
16
31
-
### Governance Model
32
-
33
-
Our Governance model helps outline our project's decision making and roles-based expectations. Read more in our [GOVERNANCE.md](GOVERNANCE.md).
34
-
35
17
### Developer Environment
36
18
37
19
For patch contributions, see our [Developer Documentation](https://github.com/NASA-AMMOS/openmct-mcws/wiki) for more details on how to set up your local environment, to best contribute to our project.
@@ -75,8 +57,8 @@ Make sure people are aware you're working on a patch! Check out our [issue track
75
57
#### Choose the Right Branch to Fork
76
58
77
59
Our project typically has the following branches available, make sure to fork either the default branch or a branch someone else already tagged with a particular issue ticket you're working with.
78
-
-`develop`— default branch, used for new code development
79
60
-`main`— release branch
61
+
-`develop`— optional default branch, used primarily for new code development
80
62
81
63
### Make your Modifications
82
64
@@ -94,8 +76,6 @@ This makes sure that tickets are updated on GitHub with references to commits th
94
76
95
77
Commit should always be atomic. Keep solutions isolated whenever possible. Filler commits such as "clean up white space" or "fix typo" should be merged together before making a pull request, and significant sub-feature branches should be [rebased](https://www.youtube.com/results?search_query=git+rebase) to preserve commit history. Please ensure your commit history is clean and meaningful!
96
78
97
-
Additionally, remember to "Sign-Off" on your commits to align with our [Developer Certificate of Origin (DCO) policy](#developer-certificate-of-origin-dco).
98
-
99
79
### Submit a Pull Request
100
80
101
81
Pull requests are the core way our project will receive your patch contributions. Navigate to your branch on your own fork within the version control system, and submit a pull request or submit the patch text to our project.
@@ -182,7 +162,7 @@ Here's some guidance on submitting a new feature issue:
182
162
183
163
Security vulnerabilities should **not** be filed to the regular issue tracking system.
184
164
185
-
Report your security vulnerabilities to (see contact links): [@jl-0](https://github.com/jl-0) or [@jeffreypon](https://github.com/jeffreypon)
165
+
Report your security vulnerabilities to (see contact links): [@jl-0](https://github.com/jl-0) or [@sharimayer](https://github.com/sharimayer)
186
166
187
167
Please be sure to:
188
168
* Indicate the severity of the vulnerability
@@ -238,7 +218,7 @@ The overall structure of our project documentation is as follows:
238
218
-[README.md](README.md) - top-level information about how to run, build, and contribute to the project
239
219
-[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - best practices and guidance on how to work well with other people in the project, and suggestions on dealing with interpersonal issues
240
220
-[CONTRIBUTING.md](CONTRIBUTING.md) - guidance on contributing to the project
241
-
-`*.java` - inline documentation available inside code files
221
+
-`*.java`, `*.py`, `*.sh`, etc. - inline documentation available inside code files
0 commit comments