Skip to content

Commit

Permalink
Fix nasa#490, Update Contributing.md CLA links
Browse files Browse the repository at this point in the history
Elevate CLA section to 3rd-level header and add new sub sections for
separate Framework and Apps CLAs
  • Loading branch information
astrogeco committed May 26, 2022
1 parent ef24f13 commit 6efe396
Showing 1 changed file with 54 additions and 35 deletions.
89 changes: 54 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@

So you'd like to contribute to cFS? Below are some guidelines for contributors to follow. Contributions come in all shapes and sizes. We appreciate your help with documentation, unit tests, framework code, continuous-integration, or simply reporting bugs and improvement ideas. We can't promise that we'll accept every suggestion or fix every bug in a timely manner but at the very least we'll respond to you.

## Table of Contents
[Code of Conduct](#code-of-conduct)

[Ways to Contribute](#ways-to-contribute)
* [Report Bugs](#report-bugs)
* [Feature Requests](#feature-requests)
* [Security Vulnerabilities](#security-vulnerabilities)
* [Pull Requests](#pull-requests)
* [Discussions and Questions](#discussions-and-questions)

[Writing High-Quality Code](#writing-high-quality-code)

[Quick Links to Submodules](#quick-links-to-submodules)

## Code of Conduct

This project and everyone participating in it is governed by the [cFS Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the [product team](README.md#contact-the-cfs-product-team).
Expand Down Expand Up @@ -77,21 +63,41 @@ Please view our [Security Policy](https://github.com/nasa/cFS/security/policy) f
#### Ready to Add Your Code?

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. 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. For information on commit messages, review [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). Please follow commit message convention:

```
Fix #XYZ, SHORT_DESCRIPTION
LONG_DESCRIPTION (optional)
```
#### Contributor License Agreement (CLA)
Sign and email the appropriate Contributor License agreement below to GSFC-SoftwareRelease@mail.nasa.gov and copy cfs-program@lists.nasa.gov
* Corporate Contributor License agreement : https://github.com/nasa/cFS/blob/main/Corp_CLA_GSC-18719-1%20cFS%20Bootes.pdf
* Individual Contributor License agreement : https://github.com/nasa/cFS/blob/main/Individual_CLA_GSC-18719-1%20cFS%20Bootes.pdf

### Contributor License Agreement (CLA)

Sign and email the appropriate Contributor License agreement below to [GSFC-SoftwareRelease@mail.nasa.gov](mailto:GSFC-SoftwareRelease@mail.nasa.gov) and copy [cfs-program@lists.nasa.gov](mailto:cfs-program@lists.nasa.gov).

#### cFS-Framework CLA

Submit the appropriate CLA for contributions to the cFS-Framework repositories: cFE, osal, psp, or submodules in the apps, libs, and tools directories.

- [cFS-Framework Corporate CLA](cFS_Framework_Corporate_CLA.pdf)

- [cFS-Framework Individual CLA](cFS_Framework_Individual_CLA.pdf)

#### cFS-Apps CLA

- [cFS-Apps Corporate CLA](cFS_Apps_Corporate_CLA.pdf)

- [cFS-Apps Individual CLA](cFS_Apps_Individual_CLA.pdf)

#### Create a Pull Request

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.
Expand Down Expand Up @@ -204,24 +210,31 @@ git push --force
```

#### How to Amend Commits

1. To modify your last commit message:

```sh
git commit --amend
```

2. The previous commit message will load an editor session, where you can make changes to the message, save those changes and exit. When you save and close the editor, the editor writes a new commit containing that updated commit message and makes it your new last commit. Push the new changes:

```sh
git push --force
```

1. To change the actual content of your last commit, stage those changes:

```sh
git add <file>
git add <files-to-amend>
```
2. Amend the commit:

```sh
git commit --amend
```
3. Now the last commit is replaced by your new and improved commit. Push the commit:

```sh
git push --force
```
Expand Down Expand Up @@ -262,6 +275,7 @@ All of our workflows will be available for forked repositories once enabled. To
5. Any failed steps are automatically expanded to display the results.

#### View Workflow Results

1. Navigate to Actions in the selected repository. For newly forked repositories, enable workflows after clicking on Actions.
2. In the left sidebar, click the workflow you want to view.
3. From the list of workflow runs, click the name of the run you want to see.
Expand All @@ -278,28 +292,33 @@ or
1. Workflows are under [.github/workflows](https://github.com/nasa/cFS/tree/main/).
2. Configure the files as needed. For more information on how to configure GitHub Actions, visit [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions).

#### Our Workflows
#### cFS Workflows

Information on our GitHub Action Workflows can be found in the [.github/workflows README.md](https://github.com/nasa/cFS/tree/main/.github/workflows/README.md) document.

## Quick Links to Submodules
## Links to Submodules

Before you [report bugs](#report-bugs) or submit [feature requests](#feature-requests), search through the open issues in each submodule to ensure that your ticket is relevant, not redundant, nor in conflict with other tickets:
* [cFS Bundle Issues](https://github.com/nasa/cfs/issues)
* [cFE Issues](https://github.com/nasa/cfe/issues)
* [OSAL Issues](https://github.com/nasa/osal/issues)
* [PSP Issues](https://github.com/nasa/psp/issues)

### Apps
* [ci_lab Issues](https://github.com/nasa/ci_lab/tree/296d12cde4f90d112d1578cb584ddae200a2d282)
* [sample_app Issues](https://github.com/nasa/sample_app/issues)
* [sample_lib Issues](https://github.com/nasa/sample_lib/issues)
* [sch_lab Issues](https://github.com/nasa/sch_lab/tree/882846bb778432c8780555b9d4bef45535584174)
* [to_lab Issues](https://github.com/nasa/to_lab/tree/031de3dde3f5265e98d7cd2bc154d93bee8520b0)
- [cFS Bundle Issues](https://github.com/nasa/cfs/issues)
- [cFE Issues](https://github.com/nasa/cfe/issues)
- [OSAL Issues](https://github.com/nasa/osal/issues)
- [PSP Issues](https://github.com/nasa/psp/issues)

### Framework Lab Apps

- [ci_lab Issues](https://github.com/nasa/ci_lab/tree/296d12cde4f90d112d1578cb584ddae200a2d282)
- [sample_app Issues](https://github.com/nasa/sample_app/issues)
- [sample_lib Issues](https://github.com/nasa/sample_lib/issues)
- [sch_lab Issues](https://github.com/nasa/sch_lab/tree/882846bb778432c8780555b9d4bef45535584174)
- [to_lab Issues](https://github.com/nasa/to_lab/tree/031de3dde3f5265e98d7cd2bc154d93bee8520b0)

### Other cFS Apps

### Tools
* [cFS-GroundSystem Issues](https://github.com/nasa/cFS-GroundSystem/issues)
* [elf2cfetbl Issues](https://github.com/nasa/elf2cfetbl/tree/6762b1c3b455665dae57e35f14a50fe327830391)
* [tblCRCTool Issues](https://github.com/nasa/tblCRCTool/tree/b02864ba56b12e00ab152225e3e8f9d6c039d48c)

- [cFS-GroundSystem Issues](https://github.com/nasa/cFS-GroundSystem/issues)
- [elf2cfetbl Issues](https://github.com/nasa/elf2cfetbl/tree/6762b1c3b455665dae57e35f14a50fe327830391)
- [tblCRCTool Issues](https://github.com/nasa/tblCRCTool/tree/b02864ba56b12e00ab152225e3e8f9d6c039d48c)

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

Expand Down

0 comments on commit 6efe396

Please sign in to comment.