Skip to content

Commit 6347e60

Browse files
committed
Update CONTRIBUTING.md
1 parent 2aa178e commit 6347e60

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,6 +1072,13 @@ changes to the GitHub repository, which are explained in more detail in the next
10721072
See [Pushing to the repository dev branch and documenting changes (done on all updates)](#pushing-to-the-repository-dev-branch-and-documenting-changes-done-on-all-updates)
10731073
for more details.
10741074
1075+
12. **Add release notes**: (For new features only)
1076+
When we add a feature and want to give users instructions on how to use it, add a comment to the issue
1077+
associated to the feature, with the heading `# Release notes` followed by the subheading
1078+
`## <short description of feature>`. Include screenshots if possible. See here for examples:
1079+
- https://github.com/UC-Davis-molecular-computing/scadnano/issues/1032#issuecomment-3264079100
1080+
- https://github.com/UC-Davis-molecular-computing/scadnano/issues/843#issuecomment-1683118908
1081+
10751082
TODO: add link to a more detailed tutorial walking through the steps above showing actual code that gets added
10761083
at each step.
10771084

0 commit comments

Comments
 (0)