-
Notifications
You must be signed in to change notification settings - Fork 167
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 #280 from biswajit-sarkar-007/biswajit-sarkar-007/…
…added-security.md-file/issue#260 Add stylish CONTRIBUTING.md with guidelines, community communication, and additional resources
- Loading branch information
Showing
1 changed file
with
63 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,63 @@ | ||
# 🎮 Contributing to Tic Tac Toe Game 🕹️ | ||
|
||
Thank you for considering contributing to the Tic Tac Toe game! We appreciate your interest and are excited to collaborate with you. | ||
|
||
## 🚀 How to Contribute | ||
|
||
We welcome contributions to this project! Here’s how you can get started: | ||
|
||
1. **Fork the Repository** 🍴 | ||
- Click the **Fork** button on the top right of the repository page to create a copy of the project under your GitHub account. | ||
|
||
2. **Clone Your Forked Repository Locally:** 💻 | ||
```bash | ||
git clone https://github.com/your-username/TIC-TAC-TOE.git | ||
``` | ||
3. **Navigate to the Project Directory:** 📂 | ||
```bash | ||
cd TIC-TAC-TOE/paras | ||
``` | ||
4. **Create a New Branch for Your Changes:** 🌿 | ||
```bash | ||
git checkout -b feature-branch | ||
``` | ||
5. **Make Your Changes:** ✏️ | ||
- Implement your feature or fix the bug. Please ensure your code follows the project's style guidelines for consistency. | ||
- If applicable, consider adding comments to your code to explain complex logic or functionality. | ||
|
||
9. **Submit a Pull Request:** 🔄 | ||
- Go to the original repository and click the Pull Requests tab, then click New Pull Request. Select your feature branch and provide a clear description of your changes. | ||
|
||
# 📜 Guidelines | ||
|
||
- **Code Quality** 🔍: Ensure your code is clean, well-organized, and follows the existing code style. Use meaningful variable and function names to enhance readability. | ||
- **Testing** 🧪: Thoroughly test your changes to ensure they do not break existing functionality. If you add new features, consider writing unit tests for them. | ||
- **Documentation** 📚: Update the documentation as necessary to reflect your changes. Clear documentation helps other contributors understand your work. Consider adding a README section for any new features you implement. | ||
- **Issue Tracking** 🐞: If you are fixing an issue, please reference it in your pull request description (e.g., "Fixes #issue_number"). This helps keep track of what changes address which issues. | ||
|
||
# 💬 Community and Communication | ||
|
||
- Feel free to ask questions! The community is here to help. You can reach out via the project’s issues page or directly contact me at **[email protected]**. 📧 | ||
- Join our discussions and share your ideas on how to improve the game. We encourage brainstorming and collaborative problem-solving! 💡 | ||
- Consider participating in community events or coding sprints to enhance your skills and contribute more effectively. 🎉 | ||
|
||
# 🙏 Thank You! | ||
|
||
We truly appreciate your contributions to this project! Together, we can make this Tic Tac Toe game even better. Happy coding! 🎉 | ||
|
||
# ✨ Additional Resources | ||
|
||
- [GitHub Guides](https://guides.github.com/) 📖 | ||
- [Markdown Guide](https://www.markdownguide.org/) 📝 | ||
- [JavaScript Style Guide](https://github.com/airbnb/javascript) 📏 | ||
|
||
### Additional Enhancements Made: | ||
- **Code Comments** 💬: Encouragement to add comments for complex code sections. | ||
- **Unit Testing** 🛠️: Mentioned the importance of unit tests for new features. | ||
- **README Documentation** 🗒️: Suggested adding sections in the README for new features. | ||
- **Community Engagement** 🤝: Encouraged participation in community events and coding sprints. | ||
- **Additional Resources** 🔗: Provided links to helpful resources for contributors. | ||
|
||
This version should offer clear instructions and foster a welcoming community for contributions. Feel free to adjust it further to suit your project’s needs! | ||
|
||
|
1ee6018
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.
Successfully deployed to the following URLs:
tic-tac-toe – ./
tic-tac-toe-peach-eight.vercel.app
tic-tac-toe-git-main-iamparas0s-projects.vercel.app
tic-tac-toe-iamparas0s-projects.vercel.app