Skip to content

Latest commit

 

History

History
74 lines (43 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

74 lines (43 loc) · 3.14 KB

Contributing

Hexdropper is an open source project. Contributions to this project are always welcome and appreciated!

Getting Started: General Tips and Guidelines:

The best and easiest way to contribute to this project is by submitting an issue or pull request on our GitHub repo.

When submitting an issue or pull request, please be as detailed and specific as possible to ensure that other contributors fully understand the issues you are reporting or any proposed changes you are making. It is always better to err on the side of more explanations than less! :)

Types of Contributions

Report Bugs

If you are reporting a bug, please submit an issue and include the following information:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs & Feature Implementation

Look through the project's issues page for bugs. Issues tagged with bug, enhancement, or help wanted are open to contributors who would like to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, examples, or even on the web in blog posts, articles, and such.

Proposing New Features

If you are proposing a new feature:

  • Explain in detail how it would work and try to be as specific as possible.
  • Keep the scope as narrow as possible to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

General Feedback/Reporting Other Issues

If you would like to submit general feedback, or would like to contribute in ways that are not outlined above (e.g., fixing typo/spelling mistake, factual error), please submit an issue with your proposed suggestions or changes.

Get Started!

Ready to contribute? Here's how to set up hexdropper for local development.

  1. Fork the project repository and download a copy of hexdropper locally.

  2. Install hexdropper using poetry:

    $ poetry install

If you are unfamiliar with poetry, please check out this link

  1. Use git (or similar) to create a branch for local development and make your changes:

    $ git checkout -b name-of-your-bugfix-or-feature

  2. When you're done making changes, check that your changes conform to any code formatting requirements and pass all tests.

  3. Commit your changes and open a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. Whenever possible, the pull request should always include additional tests.
  2. If the pull request adds functionality, any relevant docs should be updated.
  3. The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

Please note that the hexdropper project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.