Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

73 lines (48 loc) · 2.56 KB

Contributing to depscop

First off, thank you for considering contributing to depscop! It's people like you that make this tool great.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub and provide as much information as possible. A good bug report includes:

  • A clear and descriptive title.
  • A description of the problem and steps to reproduce it.
  • The version of depscop you are using.
  • Any relevant logs or error messages.

Suggesting Enhancements

Enhancements are also welcome! To suggest an enhancement, please open an issue on GitHub with the following details:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • The use case for the enhancement.

Contributing Code

If you want to contribute code, please follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top of the GitHub page to create a copy of the repository in your GitHub account.
  2. Clone Your Fork: Clone your fork to your local machine with the following command: 
    git clone https://github.com/your-username/deps-cop
  3. Create a Branch: Create a new branch for your feature or bug fix: 
    git checkout -b my-feature-branch
  4. Make Changes: Make your changes to the code.
  5. Commit Changes: Commit your changes with a clear and descriptive commit message: 
    git commit -m "Description of the changes"
  6. Push Changes: Push your changes to your fork: 
    git push origin my-feature-branch
  7. Create a Pull Request: Go to the original repository on GitHub and open a pull request. Provide a clear and descriptive title and description of your changes.

Code Style

Please follow the existing code style in the project. This helps to keep the codebase clean and readable.

Testing (soon)

If you add new functionality, please write tests to cover the new code. This helps ensure that the project remains stable and reliable.

Documentation

Ensure that your changes are well documented. This includes updating the README.md and any other relevant documentation files.

Getting Help

If you need help or have any questions, feel free to open an issue on GitHub.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

License

By contributing to depscop, you agree that your contributions will be licensed under the Apache 2.0 License.

Thank you for your contributions!