Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

623-docs: Contributing page #780

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ For more detailed documentation, visit [RS School Website Documentation](./readm

## Contributors

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

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

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.
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.

Comment on lines +16 to 17
Copy link
Preview

Copilot AI Feb 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to the 'RS School Website Documentation' seems incorrect. It should point to the actual documentation file, not './readme/README.md'.

Suggested change
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.
We invite you to join our development community! Follow the guidelines in the [RS School Website Documentation](./docs/documentation.md) to learn how you can get involved.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
## Financial Contributors

Expand Down
2 changes: 1 addition & 1 deletion readme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ As a large front-end community and a full-stack development school, RS School is

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

1. [`volunteering.md`](./volunteering.md): How to contribute to the project, roles for volunteers, and their contributions.
1. [`volunteering.md`](./volunteering.md)/[`contributing.md`](./contributing.md): How to contribute to the project, roles for volunteers, and their contributions.
2. [`onboarding.md`](./onboarding.md): Guide for newcomers, integration process, and community introduction.
3. [`git-pullrequest-workflow.md`](./git-pullrequest-workflow.md): Workflow guide, focusing on Git and Pull Requests.
4. [`semantic-webaccessibility.md`](./semantic-webaccessibility.md): Standards for semantic web and accessibility.
Expand Down
37 changes: 37 additions & 0 deletions readme/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
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:

### 1. Study the Project
- 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.
- Understand the project structure: what each file or directory is for.
- Run the project locally to see how it works.

### 2. You don’t have to write code immediately. Start with:
- Fixing typos or improving documentation.
- Translating documentation.
- Testing the project and reporting bugs.
- If you want to write code, begin with simple tasks: small bug fixes, refactoring, or adding tests.

### 3. Work on Issues
- 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`.
- Make sure the issue is available (not already taken by someone else).
- Comment on the issue asking if you can take it, and wait for confirmation from the maintainer.

### 4. Make Your First Pull Request (PR) [more](git-pullrequest-workflow.md)

| **The best way** | **The valid way** |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------:|
| 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. |
| Create a new branch for your work. | Create a new branch for your work. |
| Make your changes and commit them with a clear message. | Make your changes and commit them with a clear message. |
| 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. |
| Follow any feedback or requests from the reviewers. | Follow any feedback or requests from the reviewers. |

### 5. Engage with the Community
- Be respectful of reviewers and other contributors.
- Join project chats or forums to ask questions.
- Participate in discussions about new ideas and improvements.

#### Useful Tips:
- Don’t be afraid to make mistakes.
- Be patient. It may take time for reviewers to review your Pull Request.
- Learn along the way. Contributing is a great opportunity to gain knowledge.