Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 1.5 KB

contributing.md

File metadata and controls

18 lines (12 loc) · 1.5 KB
Raw

contributing guidelines

Thanks for bringing your ideas into this project!

  • Make sure your change is in line with the vision for this format.
  • Because this project tries is community-lead, you should propose all changes as issues or pull requests. Thus, everyone can then voice their opinion on the change and it can be adapted.
  • To propose large or potentially controversial changes, open an issue first. We can then discuss whether it's worth investing time into a pull request. Submit small changes such as corrected typos as pull requests immediately.
  • By participating in this project, you commit to the code of conduct.

adapting the spec

  • Make sure that you update all files that implicitly depend on the spec, such as examples or the readme.
  • Submit a pull request at validate-fptf so that it reflects the changed spec. If you're not sure how to adapt it, open an issue so that others can do this.

creating a new version

  • This project follows SemVer. Increase the major version number whenever the new version might break dependent projects.
  • Tag the commit with the new version, e.g. by running git tag -a 0.7.1 -m 'v0.7.1'. This is important for dependant projects to be able to reference a specific version of the spec.