Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 2.32 KB

Contributing Guidelines for Crookshanks Academy Open Source Project

Welcome to the Crookshanks Academy Open Source Project! We're thrilled that you're interested in contributing. By following these guidelines, you'll help maintain a positive and collaborative environment for all contributors.

Ways to Contribute

There are various ways you can contribute to the project:

  1. Bug Reports and Feature Requests: If you come across a bug or have an idea for a new feature, please submit an issue on the GitHub repository.

  2. Code Contributions: If you're a developer, you can contribute code improvements, bug fixes, and new features. Refer to the next section for details on how to submit a pull request.

  3. Documentation: Help improve the project's documentation by fixing typos, clarifying explanations, or adding new content.

Submitting Code Contributions

  1. Fork the repository by clicking the "Fork" button on the top right of the repository page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/crookshanks-academy.git

  3. Create a new branch for your changes:

    git checkout -b my-feature

  4. Make your changes and commit them with descriptive commit messages:

    git commit -m "Add new feature" -m "Description of changes..."

  5. Push your changes to your fork:

    git push origin my-feature

  6. Create a pull request by visiting the main repository and clicking on "Pull Requests." Then click "New Pull Request" to submit your changes.

Style Guidelines

  • Follow consistent coding style and naming conventions.
  • Write clear and concise code and comments.
  • Keep commit messages informative and meaningful.
  • Maintain compatibility with existing code and dependencies.

Code of Conduct

Please review and adhere to the Code of Conduct throughout your contribution process.

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Questions or Help

If you have any questions or need assistance, feel free to reach out to us by opening an issue or contacting dhruvbadaya@gmail.com.

We appreciate your contributions and look forward to building a better learning experience together!