Skip to content

Commit 7b44317

Browse files
committed
docs: add new features page
1 parent 876068a commit 7b44317

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

doc/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
- [Introduction](./hello.md)
44
- [Project Structure]()
5+
- [Creating new API features](./new_features.md)
56
- [Testing]()
67
- [Writing a new database test]()
78
- [Writing a new API test]()

doc/src/new_features.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# New API features
2+
3+
New API features must be documented where appropriate, this document aims to cover everywhere you need to update for new features.
4+
5+
Before writing new API features, generally a good idea to:
6+
7+
- Consult with other developers in the [Revolt Developers space](https://rvlt.gg/API)
8+
- If it's a relatively big feature, also [write an RFC](https://github.com/revoltchat/rfcs)
9+
10+
When your feature is ready to release, ensure to:
11+
12+
- Update backend documentation (what you're reading now!) if applicable
13+
- Update the [developers documentation](https://github.com/revoltchat/wiki) if applicable
14+
- Update the Feature Matrix (or ask someone that can to do so)
15+
- Ensure it is properly listed in the backend release changelog

0 commit comments

Comments
 (0)