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.

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

feat: add documentation and CI for contributing #93

Merged
merged 8 commits into from
Jun 9, 2022
Merged

Conversation

bhgomes
Copy link
Contributor

@bhgomes bhgomes commented Jun 9, 2022

Adds documentation and CI for contributing to manta-rs:

  • Adds CHANGELOG.md
  • Adds PULL_REQUEST_TEMPLATE.md
  • Adds automatic tag-and-release CI pipeline
  • Updates README.md

Before we can merge this PR, please make sure that all the following items have been checked off:

  • Linked to an issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Added one line describing your change in CHANGELOG.md and added the appropriate changelog label to the PR.
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Checked that changes and commits conform to the standards outlined in CONTRIBUTING.md.

- Adds CHANGELOG.md
- Adds PULL_REQUEST_TEMPLATE.md
- Updates README.md

Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
@bhgomes bhgomes self-assigned this Jun 9, 2022
@bhgomes bhgomes added this to the v1.0.0 milestone Jun 9, 2022
@bhgomes bhgomes linked an issue Jun 9, 2022 that may be closed by this pull request
@bhgomes bhgomes added changelog:added Changelog: add these changes to the `added` section of the changelog norelease labels Jun 9, 2022
Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
@bhgomes bhgomes changed the title feat: add documentation for contributing feat: add documentation and CI for contributing Jun 9, 2022
@bhgomes bhgomes marked this pull request as ready for review June 9, 2022 05:26
Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
@bhgomes bhgomes requested a review from tsunrise June 9, 2022 06:29
@bhgomes bhgomes merged commit e9ea6d1 into main Jun 9, 2022
@bhgomes bhgomes deleted the feat/add-docs branch June 9, 2022 07:15
tsunrise pushed a commit that referenced this pull request Jun 9, 2022
* feat: add documentation for contributing
* fix: update logo spacing and correct formatting for bullets
* feat: update CHANGELOG to include current changes
* fix: use full paths for CHANGELOG and CONTRIBUTING links
* fix: correct Github -> GitHub typo
* feat: add automatic tag-and-release pipeline
* feat: add label descriptions in CONTRIBUTING.md
* fix: update PULL_REQUEST_TEMPLATE links

Signed-off-by: Brandon H. Gomes <bhgomes@pm.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:added Changelog: add these changes to the `added` section of the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Tagging/Release Setup in CI
3 participants