Bug reports, feature suggestions and other contributions are greatly appreciated! While I can’t promise to implement everything, I will always try to respond in a timely manner.
- Submit bug reports and feature requests at GitHub
- Make pull requests to the
When 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
Feature requests and feedback¶
The best way to send feedback is to file an issue at GitHub.
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 :)
To set up apexpy for local development:
Clone your fork locally:
git clone email@example.com:your_name_here/apexpy.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally. Add tests for bugs and new features in the relevant test file in the
testsdirectory. The tests are run with
py.testand can be written as normal functions (starting with
test_) containing a standard
assertstatement for testing output.
When you’re done making changes, run
py.testlocally if you can:
Commit your changes and push your branch to GitHub:
git add . git commit -m "Brief description of your changes" git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website. Pull requests should be made to the
developbranch. The continuous integration (CI) testing servers will automatically test the whole codebase, including your changes, for multiple versions of Python on both Windows and Linux.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code, just make a pull request.
For merging, you should:
- Include passing tests for your changes
- Update/add documentation if relevant
- Add a note to
CHANGELOG.rstabout the changes
- Add yourself to