Skip to content

docs: add [Unreleased] changelog section and contributor guidelines (#164) #237

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

Open
sanusishafii989 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add [Unreleased] changelog section and contributor guidelines (#164) #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

All notable changes to the AnchorNet contracts are documented here.

## [Unreleased]

> Contributors: add new user-facing or codebase changes under the relevant
> category below using the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
> style and concise bullet points.

### Added

### Changed

### Deprecated

### Removed

### Fixed

### Security

## [0.9.0]

### Added
Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,13 @@ it without an off-chain registry.
1. Fork the repo and create a branch from `main`.
2. Make changes; keep formatting with `cargo fmt --all`.
3. Run `cargo fmt --all -- --check`, `cargo build`, and `cargo test`.
4. Open a pull request. CI will run format check, build, and tests.
4. Update `CHANGELOG.md` by adding a corresponding entry under `## [Unreleased]`
for every pull request that introduces user-facing or codebase changes.
5. Open a pull request. CI will run format check, build, and tests.

Follow the existing `Keep a Changelog` category headings in `## [Unreleased]`
when adding entries: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, or
`Security`.

## License

Expand Down