Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 3.01 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! By participating in this project, you agree to abide by our Code of Conduct.

We welcome contributions in the form of bug reports, feature requests, code contributions, documentation improvements, and more. Please take a moment to read through these guidelines to understand how you can contribute to our project.

Ways to Contribute

  1. Bug Reports: If you encounter a bug or unexpected behavior in the project, please open a new issue on our issue tracker with a detailed description of the problem, including steps to reproduce it if possible.

  2. Feature Requests: If you have ideas for new features or enhancements, feel free to open an issue on our issue tracker and describe the feature you'd like to see. Please provide context and use cases to help us understand the request.

  3. Pull Requests: If you want to contribute code or documentation, we welcome pull requests (PRs). Follow the guidelines below when submitting a PR:

    • Fork this repository to your GitHub account.
    • Create a new branch from the main branch for your changes.
    • Make your changes and ensure that tests (if available) pass.
    • Write clear and concise commit messages.
    • Submit a PR with a descriptive title and details about your changes.
    • Ensure that your PR addresses an existing issue or has been discussed with the maintainers.

  4. Documentation: If you want to improve the documentation, please do so by following the same PR process as outlined above.

  5. Help with Issues: You can contribute by helping to review and triage issues. Add your comments, suggestions, or confirmation of issues where necessary.

Development Setup

If you intend to work on the project, follow these steps to set up your development environment:

  1. Clone the repository to your local machine:

    git clone https://github.com/Harry-kp/cheggbot.git

  2. Install any project dependencies and development tools as specified in the project's documentation.

  3. Create a new branch for your work:

    git checkout -b feature-branch

  4. Make your changes and test thoroughly.

  5. Commit your changes with meaningful messages:

    git commit -m "Add your descriptive commit message here"

  6. Push your changes to your fork on GitHub:

    git push origin feature-branch

  7. Open a pull request (PR) against the main branch of the original repository.

Code Style and Guidelines

Please adhere to the project's coding style and guidelines. If such guidelines exist, they can be found in the project's documentation or specified in a CONTRIBUTING.md file.

Communication

If you have questions or need further assistance, please feel free to reach out to us through the GitHub issues or other communication channels provided in the project's documentation.

Thank you for your contributions!