Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (13 loc) · 842 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 842 Bytes

Contributing

Do you want to contribute? We'd love that.

Our goal is to have mostly projects that are useful to and usable by users.

How?

The easiest way is to go to https://github.com/surrealdb/awesome-surreal/edit/main/README.md. Make the changes to the file and follow the instructions to create a pull request.

When adding a new entry to the README.md file, please ensure the following:

  1. Please ensure that your entry is categorised under the relevant section.

  2. Please ensure that your entry adheres to the alphabetical ordering.

  3. Please ensure that your entry uses SurrealDB v3.0 and above.

  4. Please ensure that your entry uses the following markdown template:

    - [SurrealDB](https://github.com/surrealdb/surrealdb) - A scalable, distributed, collaborative, document-graph database, for the realtime web.