Skip to content

Commit

Permalink
Merge branch 'mariari/document-sdk-changes' (#1876)
Browse files Browse the repository at this point in the history
* origin/mariari/document-sdk-changes:
  Add Changelog explaining the changelog changes
  Update CONTRIBUTING.md to properly outline how to document SDK changes
  • Loading branch information
Fraccaman committed Sep 25, 2023
2 parents d8c2287 + 9b8e9cc commit 29448fa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
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
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.

0 comments on commit 29448fa

Please sign in to comment.