CONTRIBUTING.md

Contributing Guide ✨

Welcome to Awesome Social Chess! We appreciate your interest in contributing. All contributions are welcome! 💖

Table of Contents

• Getting Started
• Creating an Issue
• How to Contribute
• Community Support

---

Getting Started

Before you begin:

• Familiarize Yourself: Take a moment to read through the existing issues and pull requests to understand current discussions.

Creating an Issue

If you encounter a bug or have a feature request, please create an issue:

1. Search Existing Issues: Check if the issue already exists to avoid duplicates.
2. Open a New Issue:
   • Use a descriptive title.
   • Clearly describe the problem or feature request.
   • Provide steps to reproduce the issue, if applicable.
   • Include screenshots or code snippets, if helpful.

How to Contribute

We welcome contributions in the form of bugfixes, new features, documentation improvements, and more.

1. Fork the Repository 🔗

Click the "Fork" button at the top right corner of the repository page to create a copy of the repository on your GitHub account.

2. Clone Your Fork 📥

Clone the forked repository to your local machine:

git clone https://github.com/your-username/social-chess.git

3. 🌿 Create a Branch

cd awesome-social-chess
git checkout -b add-new-feature

4. ✏️ Make Changes - Make necessary improvements, such as fixing bugs, enhancing documentation, or adding new features

5. 📝 Commit Changes

Use descriptive commit messages that clearly state the purpose of your changes.

git add .
git commit -m "Add feature: description of feature"

6. ⬆️ Push Changes

git push origin add-new-feature

7. 🔄 Create a Pull Request

• Go to your forked repository on GitHub.
• Click "Compare & pull request".
• Add a title and description (e.g., "Fixes #38").
• Click "Create pull request".

Community Support

If you need help or have questions:

• Join Discussions: Participate in discussions.
• Contact Maintainers: Reach out to project maintainers if needed.