Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

113 lines (74 loc) · 2.89 KB
Raw

Contributing

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/aminalaee/mongox/issues.

If you are reporting a bug, please include:

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

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

Mongox could always use more documentation, whether as part of the official Mongox docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/aminalaee/mongox/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • 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 :)

Get Started!

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

  1. Fork the mongox repo on GitHub.

  2. Clone your fork locally

    $ git clone [email protected]:your_name_here/mongox.git

  3. Ensure poetry is installed.

  4. Install dependencies and start your virtualenv:

    $ poetry install -E dev

  5. Create a branch for local development:

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

    Now you can make your changes locally.

  6. Apply linting and formatting to the changes:

    $ ./scripts/lint

  7. When you're done making changes, check that your changes pass the tests:

    $ ./scripts/test

  8. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  9. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
  3. The pull request should work for Python 3.7, 3.8, 3.9 and 3.10. Check https://github.com/aminalaee/mongox/actions and make sure that the tests pass for all supported Python versions.

Tips

$ poetry run pytest tests/test_models.py

To run a subset of tests.