Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

92 lines (66 loc) · 3.87 KB
Raw

Contributing to DEHB

Thank you for considering contributing to DEHB! We welcome contributions from the community to help improve our project. Please take a moment to review the guidelines below before getting started.

Table of Contents

How to Contribute

There are several ways you can contribute to DEHB:

  • Reporting bugs
  • Requesting new features
  • Improving documentation
  • Fixing issues or enhancing existing features
  • Writing tests
  • Providing feedback and suggestions
  • Spreading the word

Bug Reports

If you encounter a bug while using DEHB, please help us by submitting a detailed bug report. Include the following information in your bug report:

  • A clear and descriptive title
  • A step-by-step description of how to reproduce the issue
  • Details about your environment (e.g., operating system, Python version)
  • Any relevant error messages or stack traces

Feature Requests

We appreciate your ideas and feedback for improving DEHB. If you have a feature request, please follow these guidelines:

  • Provide a clear and concise description of the feature you would like to see
  • Explain why this feature would be beneficial to DEHB
  • If possible, provide examples or use cases to illustrate the feature

Code Contributions

We welcome code contributions to DEHB! To contribute code, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your modifications or additions.
  5. Ensure that your code adheres to the code style and guidelines (see next section).
  6. Write tests to cover your changes if applicable.
  7. Commit your changes with a clear and descriptive commit message.
  8. Push your branch to your forked repository on GitHub.
  9. Submit a pull request to the main repository targeting the development branch.

Submitting a Pull Request

When submitting a pull request, please ensure the following:

  • Provide a clear and descriptive title for your pull request.
  • Reference any related issues or pull requests in the description.
  • Include a summary of the changes made and the motivation behind them.
  • Make sure that all the tests pass.
  • Ensure your code follows the project's code style and guidelines.
  • Be responsive to any feedback or questions during the review process.

Code Style and Guidelines

To maintain consistency and readability, we follow a set of code style and guidelines. Please make sure that your code adheres to these standards:

  • Use meaningful variable and function names.
  • Write clear and concise comments to explain your code.
  • Write docstrings in Google style.
  • Follow the project's indentation and formatting conventions. This can be checked by using pre-commit (pre-commit run --all-files).
  • Keep lines of code within a reasonable length (recommended maximum: 100 characters).
  • Write comprehensive and meaningful commit messages.
  • Write unit tests for new features and ensure existing tests pass.

Community Guidelines

When participating in the DEHB community, please adhere to the following guidelines:

  • Be respectful and considerate of others' opinions and ideas.
  • Avoid offensive, derogatory, or inappropriate language or behavior.
  • Help create a welcoming and inclusive environment for all participants.
  • Provide constructive feedback and suggestions.
  • Report any issues or concerns to the project maintainers.

Thank you for taking the time to read and understand our contribution guidelines. We appreciate your support and look forward to your contributions to DEHB!