diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42655f50f3..2e20ab1fda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,13 +7,30 @@ We especially welcome contributions from people from groups underrepresented in Our community aspires to be a respectful place. Please read and abide by our [Code of Conduct](https://publiclab.org/conduct). +## Quick Links for Contributors + +- [README.md Installation Instructions](https://github.com/publiclab/plots2#installation) +- [Code of Conduct](https://publiclab.org/conduct) +- [First Timers Issues](https://code.publiclab.org/#r=all) +- [Public Lab Developers Guide](https://publiclab.org/developers) +- [GSoC Ideas](https://publiclab.org/wiki/gsoc-ideas) +- [Chat & Help](https://publiclab.org/chat) + + ## First Timers Welcome! +New to open source/free software? We’re here to help! Here’s how to get started: -New to open source/free software? See our WELCOME PAGE, including a selection of issues we've made especially for first-timers. We're here to help, so just ask if one looks interesting: +1. **Fork** the PLOTS2 repository on GitHub. +2. **Clone** your fork to your computer. +3. Create a **new branch** for your changes. +4. Make your changes and **commit** them. +5. Push your branch to your fork and open a **Pull Request (PR)** against `publiclab/plots2/main`. +6. Link your PR to the relevant **issue**. -https://code.publiclab.org/#r=all +You can find a curated list of **first-timers-friendly issues** here: +[https://code.publiclab.org/#r=all](https://code.publiclab.org/#r=all) -Thank you so much! +Need more help? Ask in our **chat room**: [https://publiclab.org/chat](https://publiclab.org/chat) Learn more about contributing to Public Lab code projects on these pages: @@ -23,6 +40,19 @@ Learn more about contributing to Public Lab code projects on these pages: * https://publiclab.org/wiki/developers * https://publiclab.org/wiki/gsoc-ideas +## How to Contribute a Pull Request (PR) + +1. Pick an issue you want to work on. If it’s your first PR, try a **first-timers-only issue**. +2. Fork the repository to your account. +3. Clone your fork and create a **new branch** for your changes. +4. Make your edits (README, code, tests, etc.). +5. Commit your changes with a **clear commit message**. +6. Push the branch to your fork and open a PR against `publiclab/plots2/main`. +7. Reference the issue number in your PR description, like `Fixes #`. +8. Wait for maintainers to review. Respond politely to feedback. + +> See this guide for a visual workflow: [GitHub PR guide](https://guides.github.com/activities/forking/) + ## Bug reports & troubleshooting If you are submitting a bug/issue , please go to https://github.com/publiclab/plots2/issues/new @@ -30,3 +60,4 @@ If you are submitting a bug/issue , please go to https://github.com/publiclab/pl Follow the [First Timers Issue Template](https://github.com/publiclab/plots2/blob/main/.github/ISSUE_TEMPLATE/--first-timers-only.md) for submitting First Timers Only issues. Follow this standard [Issue Template](https://github.com/publiclab/plots2/blob/main/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md) for other issues. +Thank you for contributing! Your work helps make Public Lab software better and more welcoming to new contributors.