5 Contributions are welcome, and they are greatly appreciated! Every
6 little bit helps, and credit will always be given.
8 You can contribute in many ways:
10 Types of Contributions
11 ----------------------
16 Report bugs at https://github.com/pydanny/cached-property/issues.
18 If you are reporting a bug, please include:
20 * Your operating system name and version.
21 * Any details about your local setup that might be helpful in troubleshooting.
22 * Detailed steps to reproduce the bug.
27 Look through the GitHub issues for bugs. Anything tagged with "bug"
28 is open to whoever wants to implement it.
33 Look through the GitHub issues for features. Anything tagged with "feature"
34 is open to whoever wants to implement it.
39 cached-property could always use more documentation, whether as part of the
40 official cached-property docs, in docstrings, or even on the web in blog posts,
46 The best way to send feedback is to file an issue at https://github.com/pydanny/cached-property/issues.
48 If you are proposing a feature:
50 * Explain in detail how it would work.
51 * Keep the scope as narrow as possible, to make it easier to implement.
52 * Remember that this is a volunteer-driven project, and that contributions
58 Ready to contribute? Here's how to set up `cached-property` for local development.
60 1. Fork the `cached-property` repo on GitHub.
61 2. Clone your fork locally::
63 $ git clone git@github.com:your_name_here/cached-property.git
65 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
67 $ mkvirtualenv cached-property
69 $ python setup.py develop
71 4. Create a branch for local development::
73 $ git checkout -b name-of-your-bugfix-or-feature
75 Now you can make your changes locally.
78 5. Clean up the formatting (must be running at least Python 3.6)::
80 $ pip install -U black
83 6. When you're done making changes, check that your changes pass the tests, including testing other Python versions with tox::
88 To get tox, just pip install it into your virtualenv.
90 7. Commit your changes and push your branch to GitHub::
93 $ git commit -m "Your detailed description of your changes."
94 $ git push origin name-of-your-bugfix-or-feature
96 8. Submit a pull request through the GitHub website.
98 Pull Request Guidelines
99 -----------------------
101 Before you submit a pull request, check that it meets these guidelines:
103 1. The pull request should include tests.
104 2. If the pull request adds functionality, the docs should be updated. Put
105 your new functionality into a function with a docstring, and add the
106 feature to the list in README.rst.
107 3. The pull request should work for Python 2.7, and 3.3, 3.4, 3.5, 3.6 and for PyPy. Check
108 https://travis-ci.org/pydanny/cached-property/pull_requests
109 and make sure that the tests pass for all supported Python versions.
114 To run a subset of tests::
116 $ python -m unittest tests.test_cached-property