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 at https://github.com/pawelzny/dotty_dict/issues
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.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
authentication could always use more documentation, whether as part of the official authentication docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/pawelzny/dotty_dict/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 :)
Ready to contribute? Here’s how to set up dotty_dict for local development.
Fork the dotty_dict repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/dotty_dict.git
Install your local copy into a virtualenv. This is how you set up your fork for local development:
$ cd dotty_dict/ $ make install
or if you don’t have ‘make’, do it manually:
$ cd dotty_dict/ $ pip install poetry==1.1.14 $ poetry install --no-root
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can introduce your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ make test-all
or if you don’t have ‘make’, run tox directly:
$ poetry run tox --skip-missing-interpreters
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin HEAD
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
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.rst.
The pull request should work for: Python >=3.5,<4.0 and for >=PyPy3.8-7.3.9.
Check https://circleci.com/gh/pawelzny/dotty_dict and make sure that the tests pass for all supported Python versions.