From 511a5b52b30cde5031bcb223fdb8d3964a21b3d2 Mon Sep 17 00:00:00 2001 From: Matthew Kennedy Date: Tue, 11 Apr 2023 15:34:35 -0700 Subject: [PATCH] contrib file --- CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 4 +++- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..cc521c1b43 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# How to contribute + +The FOME project is always looking for new contributors, so thanks for your interest! + +## Submitting changes + +Create a [GitHub Pull Request](https://github.com/FOME-Tech/fome-fw/compare) with your changes to have it reviewed by the maintainers. + +Be descriptive in the description and your commit messages about what the PR does. The more information and context, the better. Referencing GitHub issues and pull requests is great. + +Each pull request should be atomic: include the minimum set of changes to go from one working configuration to another. If you want to fix multiple bugs or add multiple features, split them up for one PR per distinct issue. + +### Testing + +All PRs must pass CI gates (should see a ✅ next to the last commit) to be merged. Many builds are run (firmware for all boards, unit tests, etc) and need to all be passing before something is merged. You should of course test yourself instead of being surprised with an ❌ next to your build! + + diff --git a/README.md b/README.md index c2f516e4fc..e2fd29836d 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ TODO # Contributors -This project exists thanks to all the people who contribute their time, expertise, and testing. If you'd like to get involved, +This project exists thanks to all the people who contribute their time, expertise, and testing. + +If you'd like to get involved, see [contributing](CONTRIBUTING.md). ## Cloning the repository