Skip to content

Commit 28ec9da

Browse files
committed
Slim Infusion: Update baseline SLIM templates with core information. ...
1 parent b616121 commit 28ec9da

File tree

2 files changed

+9
-246
lines changed

2 files changed

+9
-246
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@ Thanks for taking the time to consider contributing! We very much appreciate you
66

77
Before you begin contributing to our project, it'll be a good idea to ensure you've satisfied the below pre-requisites.
88

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-
239
### License
2410

2511
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
2814

2915
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.
3016

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-
3517
### Developer Environment
3618

3719
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
7557
#### Choose the Right Branch to Fork
7658

7759
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` &mdash; default branch, used for new code development
7960
- `main` &mdash; release branch
61+
- `develop` &mdash; optional default branch, used primarily for new code development
8062

8163
### Make your Modifications
8264

@@ -94,8 +76,6 @@ This makes sure that tickets are updated on GitHub with references to commits th
9476

9577
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!
9678

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-
9979
### Submit a Pull Request
10080

10181
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:
182162

183163
Security vulnerabilities should **not** be filed to the regular issue tracking system.
184164

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)
186166

187167
Please be sure to:
188168
* Indicate the severity of the vulnerability
@@ -238,7 +218,7 @@ The overall structure of our project documentation is as follows:
238218
- [README.md](README.md) - top-level information about how to run, build, and contribute to the project
239219
- [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
240220
- [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
242222
- Hosted documentation
243223
- [Wiki Main-page](https://github.com/NASA-AMMOS/openmct-mcws/wiki)
244224
- Discussion Boards
@@ -290,12 +270,10 @@ To ensure documentation is readable and consistent by newcomers and experts alik
290270
#### Common Wording
291271

292272
Below are some commonly used words you'll want to leverage in your documentation contributions:
293-
- **AMMOS** - Advanced Multi-Mission Operations System tool set.
294-
- **Artifactory** - Lab-based artifact repository that stores compiled builds for reuse.
295-
- **GitHub** - One word with capitalization of the 'G' and 'H'.
296-
- **Jenkins** - Continuous Integration (CI) server that hosts many Lab builds.
297-
- **MIPL** - Multimission Instrument Processing Lab which hosts the project containing this repository.
298-
- **VICAR Java Build** - The build system that collects and compiles related code.
273+
- **AMMOS** - Advanced Multi-Mission Operations System tool set. AMMOS is also the eponymous organization that sponsors this repository.
274+
- **Docker** - Containerization service used to perform automated build, release and deployment.
275+
- **GitHub** - one word, and capitalization of the 'G' and the 'H'
276+
- **GitHub Actions** - Continuous Integration (CI) services that facilitate build automation
299277

300278
#### Inline Code Documentation
301279

@@ -347,4 +325,5 @@ A great way to contribute towards our project goals is to socialize and encourag
347325
- Help point project contributors and community members to conferences and publications where they may socialize their unique innovations
348326
- Schedule in-person or virtual happy-hours to help create a more social atmosphere within the project community
349327

350-
For the above ideas, use our [communication channels](#communication-channels) to propose get-togethers.
328+
For the above ideas, use our [communication channels](#communication-channels) to propose get-togethers.
329+

LICENSE

Lines changed: 0 additions & 216 deletions
This file was deleted.

0 commit comments

Comments
 (0)