Please report issues to the issue tracker.
- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code.
- Be clear and precise (do not prose, but name functions and commands exactly).
- Include the version of Arelle.
Before sending your pull requests, make sure you do the following:
- Read the contributing guidelines.
- Ensure you have signed the Contributor License Agreement (CLA).
- Check if your changes are consistent with the guidelines.
- Changes are consistent with the Coding Style.
We'd love to accept your commits! Before we can take them, we have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement (CLA).
- If you are an individual writing original source code, then you'll need to sign an individual CLA.
- If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
- Install pyenv
- Install a supported version of Python. For example,
pyenv install 3.11.1 - Create a virtual env using the minimum python version. For example,
PYENV_VERSION=3.11.1 pyenv exec python -m venv venv - Activate your environment
source venv/bin/activate - Install dependencies
pip install -r requirements-dev.txt - Verify you can run the app
- GUI
python arelleGUI.pyw - CLI
python arelleCmdLine.py
- GUI
If you have improvements or bug fixes for Arelle, send us your pull requests! For those just getting started, Github has a how to.
Arelle team members will be assigned to review your pull requests. Once the pull requests are approved and tested an Arelle team member will merge your request.
If you want to contribute, start working through the Arelle codebase, navigate to the Github "issues" tab and start looking through interesting issues. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
Before sending your pull request for review, make sure your changes are consistent with the guidelines and follow the Arelle coding style.
- When you contribute a bug fix to Arelle, make sure to fully document the bug and how it was fixed in the PR. Additionally, supply possible ways that the fix could be manually tested. This will greatly improve the testing and time required to merge the fix.
- When you contribute a new feature or plugin to Arelle, make sure to include documentation in the code with a markdown file on how to use the feature/plugin and what benefit it provides.
- When you contribute a new feature or plugin to Arelle, make sure to point at the documentation in the PR and supply ways the new feature/plugin could be manually tested. This will make testing significantly easier for the Arelle team and reduce the time required to merge the feature.
- When you contribute a new feature or plugin to Arelle, the maintenance burden is (by default) transferred to the Arelle team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.
Write commit messages according to the following guidance:
- If necessary, add one or more paragraphs with details, wrapped at 72 characters.
- Use present tense and write in the imperative: “Fix bug”, not “fixed bug” or “fixes bug”.
- Separate paragraphs by blank lines.
- Do not use special markup (e.g. Markdown). Commit messages are plain text.
Include a license at the top of new files.
Changes to Arelle Python code should conform to PEP8 guidelines