Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (84 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

133 lines (84 loc) · 3.52 KB

🤝 Contribution Guide

Thank you for your interest in contributing to Badges Discord! 🙌 This project is community-driven, and we welcome new ideas, improvements, and fixes. Below you'll find everything you need to get started.

📚 Table of Contents

🛠️ Getting Started

  1. Read the README.md: Familiarize yourself with the purpose and structure of the project.

  2. Check open issues: Look at the Issues tab to see where you can help.

  3. Clone the repository:

    git clone https://github.com/PandaDevOfficial/badges-discord.git
cd badges-discord

  4. Create a branch for your task:

    git checkout -b your-branch-name

🐞 How to Report a Bug

  1. Go to the Issues section.

  2. Click "New Issue" and select the appropriate type (bug report).

  3. Fill out the template providing:

    • Clear description of the bug.
    • Steps to reproduce it.
    • Expected behavior.
    • Screenshots or logs if possible.

💡 How to Suggest an Improvement

  1. Open a new "Issue" in the corresponding section.
  2. Describe the proposed improvement clearly and concisely.
  3. If possible, include examples or links to relevant resources.

💻 How to Contribute Code

  1. Fork the repository: Click "Fork" in the top-right corner.

  2. Clone your fork:

    git clone https://github.com/YOUR-USERNAME/badges-discord.git
cd badges-discord

  3. Create a descriptive branch:

    git checkout -b add-nitro-badge

  4. Make your changes and ensure everything works properly.

  5. Commit your changes:

    git add .
git commit -m "Add Nitro badge"

  6. Push your changes:

    git push origin add-nitro-badge

  7. Create a Pull Request: Go to your fork page and click "Compare & pull request".

🧾 Code Style and Conventions

  • Markdown: Use tables and lists to organize information.
  • Images: Place images in the /assets/ folder and use relative paths.
  • Emojis: Use emojis to improve readability and engagement.

📝 License and Commit Signing

By contributing, you agree that your changes will be under the project’s license. Additionally, commits should be signed using the following format:

git commit -s -m "Commit message"

The -s option adds a DCO (Developer Certificate of Origin) sign-off to the commit.

📜 Code of Conduct

This project follows the Contributor Covenant Code of Conduct, promoting an inclusive and respectful environment. By participating, you agree to adhere to this code.

🌟 Acknowledging Contributors

Your contributions are valuable! All contributors will be recognized in the Contributors section of the repository.

Have questions or need help? Feel free to open a new "Issue" or contact the maintainers.

We look forward to your contributions! 🚀