pubky-core/CONTRIBUTORS.md

Contributors

Create a Feature

1. (Optional) Describe the problem that the PR is solving in an issue first.
2. Fork the repo and create your feature branch.
   • Avoid having multiple features in one branch. See Separation of Concerns.
   • Do not create feature branches in the main repository.
3. Code your feature.
   • Commits do NOT need to follow any convention.
4. Create a PR when finished. Use Conventional Commits format as the PR title.
   • PR title format: type (module): Summary of the changes. Possible types are:
     • BREAKING CHANGE For changes that break the API.
     • feat For new features.
     • fix For bug fixes
     • chore For everything that is not covered in the above types.
     • The module is the workspace member name, for example homeserver, client, or testnet.
   • Use the Draft feature in case you need an early review.
   • Assign a reviewer. Every PR needs to be reviewed at least once. More reviews are possible on request.
5. Always squash the PR when merging. One commit == one feature/fix.

Versioning

1. Merge all PRs in the main branch that you want to include in the next version.
2. Update versions in the workspace Config.toml. Use SemVer.
   • Update the member dependencies too.
3. Create a PR with the title: chore: vx.x.x.
4. Let the PR review and squash + merge.
5. Publish each changed member with cargo publish
   • cargo publish -p http-relay
   • cargo publish -p pkarr-republisher
   • cargo publish -p pubky-common
   • cargo publish -p pubky-homeserver
   • cargo publish -p pubky
   • cargo publish -p pubky-testnet
6. Create a new Github release.
   • Tag: vx.x.x
   • Title: vx.x.x
   • Description: Changelog for the current version.