Skip to content

Commit 89188d2

Browse files
authored
docs: 623 - add contributing page (#780)
1 parent e3a4b26 commit 89188d2

File tree

3 files changed

+41
-4
lines changed

3 files changed

+41
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ For more detailed documentation, visit [RS School Website Documentation](./readm
77

88
## Contributors
99

10-
This project exists thanks to all the wonderful people who contribute. [[Contribute](CONTRIBUTING.md)].
10+
This project exists thanks to all the wonderful people who contribute. [[Contribute](./readme/contributing.md)].
1111

1212
<a href="https://github.com/rolling-scopes/site/graphs/contributors">
13-
<img src="https://contrib.rocks/image?repo=rolling-scopes/site" />
13+
<img src="https://contrib.rocks/image?repo=rolling-scopes/site" alt="">
1414
</a>
1515

16-
We invite you to join our development community! Follow the guidelines in the [RS School Website Documentation](readme/__rs_school_website_documentation.md) to learn how you can get involved.
16+
We invite you to join our development community! Follow the guidelines in the [RS School Website Documentation](./readme/README.md) to learn how you can get involved.
1717

1818
## Financial Contributors
1919

readme/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ As a large front-end community and a full-stack development school, RS School is
1919

2020
To ensure a smooth onboarding process and understand our procedures, please review these key files:
2121

22-
1. [`volunteering.md`](./volunteering.md): How to contribute to the project, roles for volunteers, and their contributions.
22+
1. [`volunteering.md`](./volunteering.md)/[`contributing.md`](./contributing.md): How to contribute to the project, roles for volunteers, and their contributions.
2323
2. [`onboarding.md`](./onboarding.md): Guide for newcomers, integration process, and community introduction.
2424
3. [`git-pullrequest-workflow.md`](./git-pullrequest-workflow.md): Workflow guide, focusing on Git and Pull Requests.
2525
4. [`semantic-webaccessibility.md`](./semantic-webaccessibility.md): Standards for semantic web and accessibility.

readme/contributing.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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

Comments
 (0)