Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs contributing - version and release schedule grammar #1467

Merged
merged 4 commits into from
Jul 22, 2024
Merged

Docs contributing - version and release schedule grammar #1467

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a99dc8f
change release schedule grammar and link to data model documentation
mjbear Sep 2, 2023
afc8731
change verb based on how the semantic versioning sentence reads
mjbear Sep 2, 2023
f6ff08f
update ASA interface detail to work with loopback interface issue #15…
mjbear Jan 5, 2024
fab3a9d
Update docs/dev/contributing.md with singular word
mjbear Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/dev/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ The branching policy includes the following tenets:
- PRs intended to address bug fixes and security patches should be sourced from the master branch.
- PRs intended to add new features that break backward compatibility should be discussed before a PR is created.

NTC-Templates will observes semantic versioning. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.
NTC-Templates will observe semantic versioning. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.
mjbear marked this conversation as resolved.
Show resolved Hide resolved

## Release Policy

NTC Templates has currently no intended scheduled release schedule, and will release new features in minor versions. Any breaking changes will be done in _major_ releases. There is some development to maintain a data model that is applicable across multiple vendors.
NTC Templates currently does not have an intended release schedule cadence, and will release new features in minor versions. Any breaking changes will be done in _major_ releases. There is some development to maintain [a data model that is applicable across multiple vendors](data_model.md).

When a new release is created the following should happen.

Expand All @@ -50,4 +50,4 @@ When a new release is created the following should happen.
- The description should be the changes that were added to the `version_<major>.<minor>.md` document.
- A post release PR is created with.
- Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch + 1>-beta` pyproject.toml.
- Once tests pass, merge.
- Once tests pass, merge.
Loading