Skip to content

Commit 6aae72b

Browse files
committed
docs: Add contributing guidelines and versioning instructions to the repository
1 parent 0933d96 commit 6aae72b

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Versioning and Releases
2+
3+
## Keeping roll up version tags up to date
4+
5+
Move the dynamic version identifier (ex: `v1`) to match the current SHA. This allows users to adopt a major version number (e.g. `v1`) in their workflows while automatically getting all the minor/patch updates.
6+
7+
To do this just checkout `main` given the latest version, force-create a new annotated tag, and push it:
8+
9+
```
10+
git tag -fa v1 -m "Updating v1 to 1.2.2"
11+
git push origin v1 --force
12+
```

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,8 @@ This project is licensed under the terms of the MIT open source license. Please
136136

137137
Take a look at [CODEOWNERS](./CODEOWNERS.md) to identify the maintainers.
138138

139+
Contributions are welcome! If you have an idea for a new feature or improvement, please open an issue or submit a pull request. Maintainers should use the [Contributing Guide](./CONTRIBUTING.md) to control version updates.
140+
139141
## Support
140142

141143
Got a question or issue? Open an issue in this repo and tag any of the folks in [CODEOWNERS](./CODEOWNERS.md).

0 commit comments

Comments
 (0)