-
-
Notifications
You must be signed in to change notification settings - Fork 11
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
MielomankA
wants to merge
1
commit into
main
Choose a base branch
from
docs/623-contributing-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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'.
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.