CONTRIBUTING.md

Contributing to Reactime ✨

Thank you for your interest in making Reactime even better! 😍 Your help is invaluable, and we appreciate every contribution, big or small. This guide will walk you through the process of opening issues, creating pull requests, and navigating our workflow.

New Contributor Guide 🐣

Whether you’re brand new to open source or a seasoned pro, we encourage you to:

• Check out our README.
  It’ll give you a birds-eye view of what Reactime does and how you can get involved.
• Explore these helpful resources:
  • Finding ways to contribute to open source on GitHub
  • Set up Git
  • GitHub flow
  • Collaborating with pull requests

Getting Started 🚀

If you want to understand the codebase in more detail, take a look at our Developer Guidelines. 🎊

Issues 👀

Creating a New Issue 🆕

1. Check existing issues.
   Before opening a new issue, please search if it already exists.

2. Open your own issue.
   If you can’t find an existing issue, feel free to open a new one to report bugs, request features, or suggest improvements.

Solving an Issue 🔧

1. Pick an issue.
   Browse through our open issues. We don’t officially assign them, so if something sparks your interest, go for it!

2. Open a pull request.
   Once you’re ready to propose a fix or feature, you can open a PR referencing the issue you’re solving.

Make Changes 🌈

Small Edits in the UI ✏️

• Click Make a contribution at the bottom of any documentation page to quickly fix typos, broken links, or small wording changes.
• This will take you directly to the .md file, where you can make edits and open a pull request.

Larger Changes Locally 💻

1. Install Git LFS.
   Follow the instructions here.

2. Fork the Repository.

   • GitHub Desktop:
     Getting started with GitHub Desktop walks you through setup. Then, you can fork the repo right from GitHub Desktop!
   • Command Line:
     Fork the repo and clone your fork locally so you can work on your own copy.

3. Create a working branch.
   Name it something descriptive (e.g., feature/new-feature or fix/typo-in-docs).

Commit Your Changes ✅

When you’re happy with your updates:

1. Commit them locally.
   Write clear commit messages describing what you changed and why.

2. Push to your branch.
   This makes your changes visible on GitHub.

Open a Pull Request 🔄

Once you’ve finished working and pushed your code:

1. Create the PR.
   Click on Compare & pull request on your branch to open a new PR.

2. Fill the “Ready for review” template.
   This helps reviewers quickly understand the context and purpose of your changes.

3. Link Issues.
   If your PR fixes or relates to an existing issue, link it in the PR description.

4. Allow Maintainer Edits.
   Check the box so our team can help update your branch if needed.

5. Address Feedback.
   If reviewers suggest changes, you can:

   • Apply suggested changes directly on the GitHub UI.
   • Make edits in your local branch and push them.

6. Resolve Conversations.
   Mark each PR comment as resolved once you’ve addressed it.

7. Handle Merge Conflicts.
   Check out this tutorial if you get stuck.

Your PR is Merged! 🎉

Congratulations and thank you! 💃 💃 Once we merge your PR, your contributions become part of Reactime. We appreciate every contribution, and we hope you’ll stick around for more.

If you have any further questions or ideas, don’t hesitate to open another issue or join the conversation in the repo!

---

Happy coding and welcome to the Reactime community! ✨