-
Notifications
You must be signed in to change notification settings - Fork 212
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #127 from rajdeepchakraborty-rc/contributing
Added: Contributing.md file.
- Loading branch information
Showing
2 changed files
with
61 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
|
||
|
||
# 🎮 Contributing to Collect Your GamingTools Repository | ||
|
||
Thank you for your interest in contributing to **Collect Your GamingTools**! We’re excited to see what creative ideas you bring. Follow these simple guidelines below to get started. | ||
|
||
--- | ||
|
||
## 🚀 Getting Started | ||
|
||
1. **Fork the Repository** | ||
Click the "Fork" button at the top-right corner to create your own copy of the repo. | ||
|
||
2. **Clone Your Fork** | ||
Clone your forked repository to your local machine: | ||
```bash | ||
git clone https://github.com/<your-github-username>/Collect-your-GamingTools.git | ||
``` | ||
|
||
3. **Create a New Branch** | ||
Create a new branch for your changes: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
--- | ||
|
||
## 🖌️ Making Changes | ||
|
||
1. **Code Changes** | ||
Make your modifications, ensuring they align with the project’s coding standards and code of conduct. Add exciting features, enriching documentation or squash bugs! | ||
|
||
2. **Commit Your Changes** | ||
Write meaningful commit messages: | ||
```bash | ||
git commit -m "Add: New navigation bar feature" | ||
``` | ||
|
||
3. **Push Your Changes** | ||
Push your changes to your forked repository: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
--- | ||
|
||
## 🛠️ Creating a Pull Request | ||
|
||
1. Once your changes are pushed, create a pull request (PR) on the original repository. | ||
2. Provide a detailed description of your changes and link any relevant issues. Provide relevant images/videos, if any. | ||
3. Wait for reviews and engage with feedback! | ||
|
||
--- | ||
|
||
## 🎉 Additional Notes | ||
|
||
- Make sure to sync your fork with the latest changes from the original repo before pushing new features. | ||
- Respect coding conventions and keep your code clean. Comment your changes for ease in review. | ||
|
||
Welcome to Open-Source and thank you for contributing! 🙌 |
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