Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (53 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

84 lines (53 loc) · 3.78 KB

Contributing to WhisperMe

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

We welcome contributions of all kinds from anyone. By participating in this project, you agree to abide by the code of conduct.

How Can I Contribute?

There are many ways you can contribute to WhisperMe, even if you're not a technical person:

Reporting Bugs

This section guides you through submitting a bug report for WhisperMe. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • Check the issues for a list of current known issues. You might find out that you don't need to create one.
  • Ensure the bug was not already reported by searching on GitHub under Issues.

How Do I Submit A Good Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title.
  • Describe the exact steps which reproduce the problem with as much detail as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and why this is a problem.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for WhisperMe, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Check the issues for a list of proposed features and those being worked on.
  • Check if the feature has already been suggested.

How Do I Submit A Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most WhisperMe users.

Pull Requests

The process described here has several goals:

  • Maintain WhisperMe's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible WhisperMe

General Guidelines

  • Before creating a pull request, please make sure there is an issue for the bug you want to fix or the feature you want to add.
  • For non-trivial changes, we recommend creating an issue to discuss your ideas with the maintainers first.
  • Follow the Python style guide as closely as possible.
  • Document new code based on the Google style.
  • Ensure your changes are properly tested.

Pull Request Process

  1. Fork the repository and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Code of Conduct

This project and everyone participating in it is governed by the WhisperMe Code of Conduct. By participating, you are expected to uphold this code.

Questions?

Don't hesitate to ask questions; every contributor started somewhere! We strive to build a welcoming and supportive community, so we'd be happy to help.

Thank you for contributing to WhisperMe!

With Best Wishes - Shreyan