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

Update CONTRIBUTING.md to properly outline how to document SDK changes #1876

Merged
merged 2 commits into from
Sep 25, 2023
Merged

Update CONTRIBUTING.md to properly outline how to document SDK changes #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
093a505
Update CONTRIBUTING.md to properly outline how to document SDK changes
mariari Sep 7, 2023
9b8e9cc
Add Changelog explaining the changelog changes
mariari Sep 7, 2023
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
2 changes: 2 additions & 0 deletions .changelog/unreleased/improvements/1876-updating-contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Added a section in CONTRIBUTING.md to outline how to document SDK
changes ([#1876](https://github.com/anoma/namada/pull/1876))
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The section should either be one of the following choices:
- `features`
- `improvements`
- `testing`
- `SDK`

To add a change log entry using `unclog`, you can fill in the following command (prefer to use the issue number, for which the `--pull-request` argument may be omitted):

Expand All @@ -47,6 +48,13 @@ If none of the sections fit, new sections may be added. To find the existing sec
for i in $(ls -d .changelog/*/*/); do basename "$i"; done | sort | uniq
```

#### SDK Changelog

The Namada SDK is exposed to any developer building upon Namada. Thus, any change made to a public facing function is a breaking change, and therefore should be documented in the Changelog under the `SDK` section.

The message should outline the exact API change, along with a small section describing *how* and *why* the componenet was change. This should give motivation and context to any developer building upon Namada on how they can update their code to the next version.

## Development priorities


If you’d like to follow the development or contribute with new or unimplemented features, we recommend to check [the issues](https://github.com/anoma/namada/issues) that are in current focus of the ledger team.