Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (30 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.44 KB
Raw

Contributing to OpenLyceum

Thank you for your interest in contributing to OpenLyceum simulations and tools.

How to contribute

We use GitHub Flow:

  1. Fork the repository and create a branch from main.
  2. Make your changes with clear, focused commits.
  3. Run the quality checks locally (see below).
  4. Open a pull request with a clear description of the change.

Development checks

For SceneryStack simulation repositories, run these before opening a PR:

npm install
npm run lint
npm run check
npm run build

If the repository defines npm test and CI runs tests, run npm test as well.

Pull requests

Use the repository pull request template when available. Include:

  • What changed and why
  • How you tested the change
  • Links to related issues (Fixes #123 when applicable)

Reporting bugs

Open a bug report issue in the affected simulation repository, or use the Bug report template if available.

Feature requests

Open a Feature request issue describing the use case and proposed behavior.

Code of conduct

This project follows the OpenLyceum Code of Conduct. By participating, you agree to uphold it.

License

By contributing, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 used by OpenLyceum simulation repositories.