Contributing to OpenFormats¶
- Before you file an issue, try asking for help first.
- If determined to file an issue, first check for existing issues, including closed issues.
How to get help¶
Before you ask for help, please make sure you do the following:
- Read the documentation thoroughly. If in a hurry, at least use the search field that is provided on the documentation pages.
- Use a search engine (e.g., DuckDuckGo, Google) to search for a solution to your problem. Someone may have already found a solution.
- Try reproducing the issue in a clean environment, ensuring you are using:
- correct latest OpenFormats release (or an up-to-date git clone of master)
- latest releases of libraries used by Openformats
- no plugins or only those related to the issue
If despite the above efforts you still cannot resolve your problem, be sure to include in your inquiry the following information, preferably in the form of links to content uploaded to a paste service, GitHub repository, or other publicly-accessible location:
- Describe what version of Openformats you are running
or the HEAD commit hash if you cloned the repo) and how exactly you installed
it (the full command you used, e.g.
pip install openformats).
- If you are looking for a way to get some end result, prepare a detailed description of what the end result should look like (preferably in the form of an image or a mock-up page) and explain in detail what you have done so far to achieve it.
- If you are trying to solve some issue, prepare a detailed description of how to reproduce the problem. If the issue cannot be easily reproduced, it cannot be debugged by developers or volunteers. Describe only the minimum steps necessary to reproduce it (no extra plugins, etc.).
- Upload any settings file or any other custom code that would enable people to reproduce the problem or to see what you have already tried to achieve the desired end result.
- Upload detailed and complete output logs and backtraces.
Once the above preparation is ready, you can contact people willing to help via
a GitHub issue or send a message to
support at transifex dot com.
Remember to include all the information you prepared.
Before you submit a contribution, please ask whether it is desired so that you don’t spend a lot of time working on something that would be rejected for a known reason.
Using Git and GitHub¶
- Create a new git branch specific to your change (as opposed to making your commits in the master branch).
- Don’t put multiple unrelated fixes/features in the same branch / pull request. For example, if you’re hacking on a new feature and find a bugfix that doesn’t require your new feature, make a new distinct branch and pull request for the bugfix.
- Check for unnecessary whitespace via
git diff --checkbefore committing.
- First line of your commit message should start with present-tense verb, be 50
characters or less, and include the relevant issue number(s) if applicable.
Ensure proper PLUGIN_PATH behavior. Refs #428.If the commit completely fixes an existing bug report, please use
Fix #585syntax (so the relevant issue is automatically closed upon PR merge).
- After the first line of the commit message, add a blank line and then a more detailed explanation (when relevant).
- Squash your commits to eliminate merge commits and ensure a clean and readable commit history.
- If you have previously filed a GitHub issue and want to contribute code that
addresses that issue, please use
hub pull-requestinstead of using GitHub’s web UI to submit the pull request. This isn’t an absolute requirement, but makes the maintainers’ lives much easier! Specifically: install hub and then run hub pull-request to turn your GitHub issue into a pull request containing your code.
Contribution quality standards¶
- Adhere to PEP8 coding standards whenever possible. This can be eased via the pep8 or flake8 tools, the latter of which in particular will give you some useful hints about ways in which the code/formatting can be improved.
- Add docs and tests for your changes. Undocumented and untested features will not be accepted.
- Run all the tests on all versions of Python supported by Openformats to ensure nothing was accidentally broken.
Check out our Git Tips page or ask for help if you need assistance or have any questions about these guidelines.