diff --git a/README.md b/README.md index 457400cf3..8bf58d943 100644 --- a/README.md +++ b/README.md @@ -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)]. - + -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. ## Financial Contributors diff --git a/readme/README.md b/readme/README.md index d789f3b6e..aed06d47d 100644 --- a/readme/README.md +++ b/readme/README.md @@ -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. diff --git a/readme/contributing.md b/readme/contributing.md new file mode 100644 index 000000000..523f262b2 --- /dev/null +++ b/readme/contributing.md @@ -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.