Skip to content

Commit

Permalink
feat: v1 of contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
njlyon0 committed Aug 30, 2024
1 parent 26b4da9 commit 31d9bee
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## LTER Scientific Computing Contributing Guidelines

This document is meant to focus primarily on our _internal_ processes for contributing. If you're not a member of this team, we hope you find this document valuable as-is but you should also feel free to make any modifications you feel are necessary if you choose to use our guidelines as a starting place.

### Version Control & GitHub

As much as possible, use the style of "[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)" in your commit messages. See [here](https://njlyon0.github.io/tips/commits.html) for a nice summary of the highlights of that approach.

For **minor changes**, (1) communicate with the team to avoid merge conflicts and (2) make commits directly to `main`

For **_major_ changes**, (1) communicate with the team to avoid merge conflicts, (2) open a branch with an intuitive but concise name, and (3) open a pull request when you are confident your edits are largely complete. (4) Request a review from a teammate, (5) make any edits they suggest, (6) merge the PR, and (7) delete the branch.

0 comments on commit 31d9bee

Please sign in to comment.