Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (30 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.83 KB
Raw

Contributing to the EVERSE Reference Framework

Thank you for your interest in contributing! The Reference Framework is developed collaboratively by the EVERSE community, and contributions of all kinds are welcome.

Ways to contribute

  • Report an issue — spotted an error, inconsistency, or gap? Open a GitHub issue.
  • Propose a change — suggest improvements to existing content via a pull request.
  • Add new content — propose new sections or expand existing ones.
  • Review open pull requests — feedback from domain experts is always valuable.

Before you start

For small fixes (typos, broken links, minor clarifications) you can open a pull request directly.

For larger changes — new sections, structural reorganisation, or changes to core definitions — please open an issue first to discuss the proposal with the team. This avoids duplicated effort and ensures alignment before significant work is done.

Contribution process

  1. Fork this repository and create a branch from main.
  2. Make your changes in the relevant Markdown file(s) under source/.
  3. Build locally (optional but recommended) to check the output looks correct — see the local build instructions in the README.
  4. Open a pull request against main with a clear description of what you changed and why.
  5. A maintainer will review and may request changes before merging.

Content guidelines

  • Write in clear, accessible English.
  • Use the existing Markdown structure and heading hierarchy.
  • Keep the tone consistent with the rest of the document — precise but readable.
  • If adding figures, place them in source/figures/ and reference them with a relative path and a { width=70% } attribute (or appropriate width).
  • Metadata (title, version, authors) lives in source/main.md — do not edit version numbers without coordinating with the maintainers.

Meeting notes

TF2 rolling meeting minutes are maintained at meetings/tf2-rolling-notes.md and collaboratively edited on HackMD. After each meeting, the updated notes are pushed to this repository via a pull request.

Section ownership

Each chapter and section has an owner listed in the README. If your change touches a specific section, it is good practice to request a review from the relevant owner.

Licensing

By submitting a contribution, you agree that your work will be released under the Creative Commons Attribution 4.0 International License that covers this repository.

Questions

If you are unsure where to start or have questions about the contribution process, open an issue or contact the maintainers: @gperu and @fdiblen.