Contributing

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

Bug reports

Whenreporting 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.

Documentation improvements

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

Feature requests and feedback

The best way to send feedback is to file an issue athttps://github.com/ionelmc/python-aspectlib/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 code contributions are welcome :)

Development

To set uppython-aspectlib for local development:

  1. Forkpython-aspectlib(look for the “Fork” button).

  2. Clone your fork locally:

    gitclonegit@github.com:your_name_here/python-aspectlib.git

  3. Create a branch for local development:

    gitcheckout-bname-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes, run all the checks, doc builder and spell checker withtox one command:

    tox

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

    gitadd.gitcommit-m"Your detailed description of your changes."gitpushoriginname-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (runtox)[1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note toCHANGELOG.rst about the changes.
  4. Add yourself toAUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it willrun the tests for each change you add in the pull request.

It will be slower though …

Tips

To run a subset of tests:

tox-eenvname--py.test-ktest_myfeature

To run all the test environments inparallel (you need topipinstalldetox):

detox