Skip to content

Contributing ​

Thanks for your interest in contributing to AutoAPMS Studio! This page describes the typical workflow and a few guidelines to make the review process smooth.

Quick workflow ​

  1. Fork the repo and create a feature branch based on develop:
bash
git switch develop
git switch -c feat/<short-description>
  1. Implement your changes and add tests.
  2. Run tests and linters locally.
  3. Push your branch and open a Pull Request (PR) against develop. Describe the change, rationale and testing steps. master only receives releases (see Release process).

Review & testing ​

  • Keep PRs small and focused to speed up review.
  • Include unit tests for backend logic and JavaScript frontend logic.
  • The maintainers will review and may request changes. Please respond to feedback and keep the branch up to date.

Before you open a PR ​

  • Run linters and type checks.
  • Update developer docs (docs/dev-guide/) if your change affects public backend APIs or development setup.
  • If you change user-visible behavior, also update the user guide.

Tip: Small, well-documented PRs are reviewed faster. Add a short testing checklist to the PR description.

Released under the Apache-2.0 License.