Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 2.55 KB
Raw

Contributing to Dravid (DRD)

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

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

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

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

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

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps or point out the part of Dravid where the enhancement could be implemented.
  • Explain why this enhancement would be useful to most Dravid users.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the Python styleguide
  • Include thoughtfully-worded, well-structured tests
  • Document new code based on the Documentation Styleguide
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

All Python code must adhere to the PEP 8 style guide.

Documentation Styleguide

  • Use Markdown for documentation.
  • Reference functions and classes in backticks.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug: Something isn't working
  • enhancement: New feature or request
  • help wanted: Extra attention is needed
  • question: Further information is requested

Getting Started

For instructions on setting up your environment and running tests, please see the README.md file.

Thank you for contributing to Dravid!