Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
140 lines (97 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

140 lines (97 loc) · 3.71 KB

Contributing to Code District

Thank you for considering contributing to Code District! We value your time and effort and appreciate your help in improving our projects. Below are the guidelines for contributing to this repository.

📋 Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Getting Started
  4. Issue Reporting
  5. Pull Requests
  6. Style Guide
  7. Community Support

How to Contribute

We welcome various forms of contributions, including:

  • Reporting bugs
  • Suggesting features
  • Writing or improving documentation
  • Writing tests
  • Submitting fixes or improvements
  • Reviewing pull requests

Code of Conduct

Please make sure to read and adhere to our Code of Conduct.
All contributors are expected to create a welcoming and friendly environment for everyone.

Getting Started

  1. Fork the Repository:
    Click the "Fork" button in the top-right corner of this repository.

  2. Clone the Forked Repository:
    Clone your fork to your local machine:

    git clone https://github.com/your-username/repo-name.git

  3. Set the Upstream:
    Link the original repository as the upstream:

    git remote add upstream https://github.com/Code-District-Team/repo-name.git

  4. Create a Branch:
    Always work on a new branch. Avoid making changes on the main branch.

    git checkout -b feature/your-feature-name

  5. Make Changes:
    Make your changes locally. Ensure that your code adheres to the project’s style guidelines.

  6. Commit Your Changes:
    Write clear and descriptive commit messages:

    git add .
git commit -m "Add description of your changes"

  7. Push to Your Fork:
    Push your branch to your forked repository:

    git push origin feature/your-feature-name

  8. Open a Pull Request:
    Go to the original repository and open a pull request. Describe your changes in detail.

Issue Reporting

If you encounter any bugs or have a feature request, please:

  1. Check Existing Issues:
    Make sure the issue hasn’t already been reported or addressed.

  2. Open a New Issue:
    Provide a clear and descriptive title and include:

    • Steps to reproduce the issue
    • Expected and actual behavior
    • Screenshots, logs, or error messages (if applicable)

Pull Requests

  • Ensure your pull request addresses a single issue or feature.
  • Provide a detailed description of the problem and your solution.
  • Reference the issue number (if applicable) in your pull request (e.g., Fixes #123).
  • Include tests, if relevant.
  • Ensure your code builds successfully and passes all tests before submitting.

Style Guide

Follow the project’s coding conventions and standards:

  1. Languages and Frameworks:

    • JavaScript/TypeScript: Use ESLint for code linting.
    • Python: Follow PEP 8 guidelines.
    • [Add your project-specific conventions here].

  2. Documentation:

    • Use clear and concise language.
    • Update relevant documentation in the docs/ folder or README.

  3. Testing:

    • Write tests for new features or bug fixes.
    • Use existing test frameworks as per the project setup.

Community Support

If you have questions or need support, feel free to:

Thank you for helping us build amazing projects! Together, we can create something exceptional. 🚀

Let me know if you’d like to modify or add anything else to this guide!