|
| 1 | +Contributing ([volunteering](volunteering.md)) to open-source projects is a great way to improve your skills and help the community. Here’s a step-by-step guide to getting started: |
| 2 | + |
| 3 | +### 1. Study the Project |
| 4 | +- Familiarize yourself with the [repository](https://github.com/rolling-scopes/site): read the [README.md](README.md), [contributing.md](contributing.md), [git-pullrequest-workflow.md](git-pullrequest-workflow.md) and other documentation. |
| 5 | +- Understand the project structure: what each file or directory is for. |
| 6 | +- Run the project locally to see how it works. |
| 7 | + |
| 8 | +### 2. You don’t have to write code immediately. Start with: |
| 9 | +- Fixing typos or improving documentation. |
| 10 | +- Translating documentation. |
| 11 | +- Testing the project and reporting bugs. |
| 12 | +- If you want to write code, begin with simple tasks: small bug fixes, refactoring, or adding tests. |
| 13 | + |
| 14 | +### 3. Work on Issues |
| 15 | +- Look for suitable `issues` in the [Issues](https://github.com/rolling-scopes/site/issues) section on GitHub or [dashboard](https://github.com/orgs/rolling-scopes/projects/6/views/1), or create a task and assign it to yourself ([more](git-pullrequest-workflow.md)). For beginners, look for issues labeled with `good first issue`. |
| 16 | +- Make sure the issue is available (not already taken by someone else). |
| 17 | +- Comment on the issue asking if you can take it, and wait for confirmation from the maintainer. |
| 18 | + |
| 19 | +### 4. Make Your First Pull Request (PR) [more](git-pullrequest-workflow.md) |
| 20 | + |
| 21 | +| **The best way** | **The valid way** | |
| 22 | +|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------:| |
| 23 | +| Gain all necessary access to the repository and dashboard to work with them directly (eliminating issues with tests and workflow) by reaching out to the owners (e.g., dzmitry-varabei). | Fork the repository. | |
| 24 | +| Create a new branch for your work. | Create a new branch for your work. | |
| 25 | +| Make your changes and commit them with a clear message. | Make your changes and commit them with a clear message. | |
| 26 | +| Push your branch to the repository and open a Pull Request to the main branch | Push your branch to your fork and open a Pull Request to the main repository. | |
| 27 | +| Follow any feedback or requests from the reviewers. | Follow any feedback or requests from the reviewers. | |
| 28 | + |
| 29 | +### 5. Engage with the Community |
| 30 | +- Be respectful of reviewers and other contributors. |
| 31 | +- Join project chats or forums to ask questions. |
| 32 | +- Participate in discussions about new ideas and improvements. |
| 33 | + |
| 34 | +#### Useful Tips: |
| 35 | +- Don’t be afraid to make mistakes. |
| 36 | +- Be patient. It may take time for reviewers to review your Pull Request. |
| 37 | +- Learn along the way. Contributing is a great opportunity to gain knowledge. |
0 commit comments