Skip to content

Commit

Permalink
Fix #194, Create Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arielswalker committed Mar 2, 2021
1 parent b401289 commit 3fe8482
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Tools

If your bug or feature hasn't been reported or requested before, create a new issue in the appropriate repository. If it you find a similar issue, please add a comment on it with your experience or input.

Please ensure that your name is associated with your github profile before contributing.

## Ways to Contribute

### Report Bugs
Expand Down Expand Up @@ -84,13 +86,15 @@ Please view our [Security Policy](https://github.com/nasa/cFS/security/policy) f

Follow GitHub's fork-branch-pull request pattern.
1. Fork the relevant cFS component (eg. cfe, osal, psp).
2. Create a new branch in your fork to work on your fix. Please name your branch `fix-ISSUE_NUMBER-<FIX_SUMMARY>`.
2. Create a new branch in your fork to work on your fix. We recommend naming your branch `fix-ISSUE_NUMBER-<FIX_SUMMARY>`.
3. Submit a pull request to the nasa `main` branch. We recommend creating your pull-request as a "draft" and to commit early and often so the community can give you feedback at the beginning of the process as opposed to asking you to change hours of hard work at the end.
4. Add commits to your branch. Please follow commit message convention: `Fix ISSUE_NUMBER, 50-ish-character-long summary of commit content`.
5. Download print, sign, and email our [contributor license agreement]() to FIXME.
5. Sign and email the appropriate Contributor License agreement down below to GSFC-SoftwareRelease@mail.nasa.gov and copy cfs-program@lists.nasa.gov.
- Corporate Contributor License agreement : https://github.com/nasa/cFE/blob/main/docs/GSC_18128_Corp_CLA_form_1219.pdf
- Individual Contributor License agreement : https://github.com/nasa/cFE/blob/main/docs/GSC_18128_Ind_CLA_form_1219.pdf

#### Create a Pull Request
1. For the title, use the template `Fix #XYZ, SHORT_DESCRIPTION`. The title should be the same as the commit message.
1. For the title, use the title convention `Fix #XYZ, SHORT_DESCRIPTION`.
2. Describe the contribution. First document which issue number was fixed using the template "Fix #XYZ". Then describe the contribution.
3. Provide what testing was used to confirm the pull request resolves the link issue.
4. Provide the expected behavior changes of the pull request.
Expand All @@ -106,7 +110,7 @@ Follow GitHub's fork-branch-pull request pattern.
5. If the pull request is accepted, it will be merged into cFS.

### Discussions and Questions
For best results, submit issues:questions or issues:help wanted requests to this repo.
Do not submit a GitHub issue for questions and help. For best results, email us at cfs-program@lists.nasa.gov.

## Writing High-Quality Code

Expand Down

0 comments on commit 3fe8482

Please sign in to comment.