Skip to content

Latest commit

 

History

History
90 lines (54 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

90 lines (54 loc) · 2.79 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it's a problem. If you've found a bug, create an associated issue including with detailed instructions for reproducing it.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Expected vs. actual results.
  • Detailed steps to reproduce the bug.
  • Screenshots, if applicable.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants 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, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  1. Check existing issues to avoid duplicates.

  2. Open a new issue with the label feature request.

  3. Keep the scope as narrow as possible, to make it easier to implement.

  4. Include:

    • A detailed description of the feature and how it would work.

    • Use cases and why it would be helpful.

Get Started!

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

  1. Download a copy of date_extractor_mds locally.

  2. Install date_extractor_mds using poetry:

    $ poetry install

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

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

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

  5. Commit your changes and open a pull request.

Pull Request Guidelines

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

  1. The pull request should include additional tests if appropriate.
  2. If the pull request adds functionality, the 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 date_extractor_mds project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.

Attribution

This file was adapted from a template provided as part of py-pkgs-cookiecutter.