archived-pie/CONTRIBUTING.md

Contributing to PIE

Thank you for taking an interest in contributing to PIE.

Important

The TL;DR version of this is please either open an issue if you think you have found a bug, or create a discussion if you have an idea for a new feature, BEFORE starting work on any code changes. Submitting a pull request without checking first may be duplicating work that is already in progress!

Reporting bugs

If you think you have a bug, please open an issue, and include:

• What platform and PIE version you're using
• The steps to reproduce the issue - please use the -v verbose flag (or higher)
• Complete error messages and/or logs, including stack traces (hint: use -v for verbose), but please redact sensitive information

Submitting PRs

Please do not just submit PRs for features or ideas without discussing them first. Start by creating a discussion first if there is not already an open discussion or issue. If there is already an open discussion or issue, please comment and wait for feedback before starting any work. This is because the work may already be in progress or being investigated already. The PIE project is actively being developed, and many features are already in discussion or being developed, so if you do not discuss with us first, you may be duplicating work already in progress.

Tip

We try to stay on top of issues already being worked on with the maintainer investigating purple label. If you see this on an issue, it is very likely we are already looking into this.