Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #8

Merged
merged 2 commits into from
Nov 27, 2023
Merged

Update CONTRIBUTING.md #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca59ba6
Update CONTRIBUTING.md
dinkelk Nov 27, 2023
fda2c9a
Update CONTRIBUTING.md
dinkelk Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Adamant welcomes any and all contributions! Do you have something to add?

This file provides basic information on how to contribute to the Adamant software framework.
This file provides information on how to contribute to the Adamant software framework.

While we encourage all contributions, remember that Adamant is used everyday to create reliable and efficient software for safety-critical applications including spacecraft. As such, code quality is important, and you may be asked to make adjustments to your submission prior to inclusion.

Expand All @@ -20,14 +20,22 @@ All pull requests are reviewed by an Adamant maintainer and the community. Your

### Tests and Checks

Adamant leverages [GitHub Actions](https://docs.github.com/en/actions) to unit test and style check the code. These automated checks will be run after a maintainer has reviewed your request. All checks must pass successfully before your pull request can be included.
Adamant leverages [GitHub Actions](https://docs.github.com/en/actions) to unit test and style check the code. These automated checks will be initiated when a pull request has been opened. All checks must pass successfully before your pull request can be included.

Note that many of these checks are annoyingly pedantic, but this helps ensure uniformity and quality in the Adamant code base. Adamant maintainers may make commits on your pull request to correct minor issues.

### Approval and Merge

Once the pull request is passing all tests and checks and has been approved by a maintainer it will be merged into the Adamant repository!

## Contribution Ownership

Contributions to Adamant will abide by the [GitHub Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service#6-contributions-under-repository-license) which states:

> Whenever you add Content to a repository containing notice of a license, you license that Content under the same terms, and you agree that you have the right to license that Content under those terms.

In short, you will own the copyright to the portion of the code that you modify, and that code will be licensed under the Apache-2.0 license.

## Questions?

Ask using the project's [discussions](https://github.com/lasp/adamant/discussions).