From 7b44317705112e53b71a2bf7fcecce9888f3a445 Mon Sep 17 00:00:00 2001 From: Paul Makles Date: Thu, 24 Oct 2024 17:45:10 +0100 Subject: [PATCH] docs: add new features page --- doc/src/SUMMARY.md | 1 + doc/src/new_features.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 doc/src/new_features.md diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md index 1b15bc68..e772ccd7 100644 --- a/doc/src/SUMMARY.md +++ b/doc/src/SUMMARY.md @@ -2,6 +2,7 @@ - [Introduction](./hello.md) - [Project Structure]() +- [Creating new API features](./new_features.md) - [Testing]() - [Writing a new database test]() - [Writing a new API test]() diff --git a/doc/src/new_features.md b/doc/src/new_features.md new file mode 100644 index 00000000..82f068a1 --- /dev/null +++ b/doc/src/new_features.md @@ -0,0 +1,15 @@ +# New API features + +New API features must be documented where appropriate, this document aims to cover everywhere you need to update for new features. + +Before writing new API features, generally a good idea to: + +- Consult with other developers in the [Revolt Developers space](https://rvlt.gg/API) +- If it's a relatively big feature, also [write an RFC](https://github.com/revoltchat/rfcs) + +When your feature is ready to release, ensure to: + +- Update backend documentation (what you're reading now!) if applicable +- Update the [developers documentation](https://github.com/revoltchat/wiki) if applicable +- Update the Feature Matrix (or ask someone that can to do so) +- Ensure it is properly listed in the backend release changelog