Contribution to the project is very welcome and always needed. Please see the below guidelines for contributing to the project. If you have more questions, please feel free to join us on slack.
Should always contain:
- Issue detail
- Resolution detail
Please tag issues appropriately for tracking purposes.
Should contain:
- QA Instructions
- ...anything else you find useful i.e. notes, todo list
- ...maybe some comments from the review process
Can contain:
- Proposals
- Ideas
- Q&A
We try to keep our project boards updated to reflect the current workload and priorities.
Only AppScope team members can approve and merge PR's.
AppScope team members must have MFA on their GitHub account ; and use a GPG key to sign commits.
TBD - Please see the open discussion on coding style.
Every PR should be tested in some way, sometimes by a manual QA reviewer, but preferably by an extension to integration or unit tests.
Every PR must pass the GitHub Actions CI pipeline 100%, which includes build, unit test, and integration test steps.
We use these to test features and should be the focal point of testing.
Integration tests live in test/integration/.
We use these to test subsets of features where appropriate.
Unit Tests for the C code live in test/unit/.
Unit Tests for the Go code live in cli/__package__/.
With every release, we should update user documentation. User documentation lives in the website directory, and is published to appscope.dev.
Please keep in mind the current set of limitations and requirements for using AppScope. We want to ensure that we maintain or shrink these where possible, and avoid growing them. For example, we want to AppScope to work on all popular linux distributions and versions; on glibc and musl environments ; with apps written in any language, etc.
We want to maintain backwards compatibility with previous versions of AppScope in almost all cases.
We want to maintain our current licensing terms found in LICENSE.