Contributions to this repository are intended to follow the VRS development process. The additional information presented here are guidelines for issues, branches, commits, and pull requests. Before adding documentation, please also review the docs style guide.
Discussions are for feature requests, release candidate discussions, and questions.
Issues are for bug reports, and planned feature descriptions. When creating an issue, use sentence case for the issue title and avoid the use of periods at the end of titles.
Branches are used for
versioning and feature additions. Version branches are to be created by
repo administrators only. Feature branches must be associated with an
open issue describing the desired feature, and named after the issue
as -. For example, the associated
branch for issue 250 could
be 250-contributing.
Pull Requests (PRs) for new
features should target the main branch. For version
patches, the PR should target the appropriate minor version branch.
PRs must be approved by at least one project maintainer before they may
be merged. PR titles must reflect the issue associated with the PR. For
example, the associated PR title for
issue 250 would be
#250: Add CONTRIBUTING.md, as seen in
PR #253.