|
| 1 | +# Welcome to the Reactime contributing guide! |
| 2 | + |
| 3 | +Thank you for investing your time in contributing to our project! :sparkles:. |
| 4 | + |
| 5 | +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. |
| 6 | + |
| 7 | +## New contributor guide |
| 8 | + |
| 9 | +To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: |
| 10 | + |
| 11 | +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) |
| 12 | +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) |
| 13 | +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) |
| 14 | +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
| 15 | + |
| 16 | + |
| 17 | +## Getting started |
| 18 | + |
| 19 | +To navigate our codebase with confidence, see the Developer READMEs [Developer Installation](/DeveloperREADME.md) and [Developer Guidelines](/src/README.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md). |
| 20 | + |
| 21 | +### Issues |
| 22 | + |
| 23 | +#### Create a new issue |
| 24 | + |
| 25 | +If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new). |
| 26 | + |
| 27 | +#### Solve an issue |
| 28 | + |
| 29 | +Scan through our [existing issues](https://github.com/open-source-labs/reactime/issues) to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. |
| 30 | + |
| 31 | +### Make Changes |
| 32 | + |
| 33 | +#### Make changes in the UI |
| 34 | + |
| 35 | +Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. |
| 36 | + |
| 37 | +#### Make changes in a codespace |
| 38 | + |
| 39 | +For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." |
| 40 | + |
| 41 | +#### Make changes locally |
| 42 | + |
| 43 | +1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage). |
| 44 | + |
| 45 | +2. Fork the repository. |
| 46 | +- Using GitHub Desktop: |
| 47 | + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. |
| 48 | + - Once Desktop is set up, you can use it to [fork the repo](https://github.com/open-source-labs/reactime.git)! |
| 49 | + |
| 50 | +- Using the command line: |
| 51 | + - [Fork the repo](https://github.com/open-source-labs/reactime.git) so that you can make your changes without affecting the original project until you're ready to merge them. |
| 52 | + |
| 53 | +3. Create a working branch and start with your changes! |
| 54 | + |
| 55 | +### Commit your update |
| 56 | + |
| 57 | +Commit the changes once you are happy with them. |
| 58 | + |
| 59 | +### Pull Request |
| 60 | + |
| 61 | +When you're finished with the changes, create a pull request, also known as a PR. |
| 62 | +- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. |
| 63 | +- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. |
| 64 | +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. |
| 65 | +Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information. |
| 66 | +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. |
| 67 | +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). |
| 68 | +- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. |
| 69 | + |
| 70 | +### Your PR is merged! |
| 71 | + |
| 72 | +Congratulations :tada::tada: The Reactime team thanks you! :sparkles:. |
| 73 | + |
| 74 | +Once your PR is merged, your contributions will be publicly visible on [Reactime](https://github.com/open-source-labs/reactime)!. |
0 commit comments