add contributing md
This commit is contained in:
parent
02bb6bcd09
commit
2f18b6cf43
1 changed files with 14 additions and 0 deletions
14
CONTRIBUTING.MD
Normal file
14
CONTRIBUTING.MD
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# Contribution Guidelines
|
||||||
|
Welcome to the contribution guideline document. Spacebar Network is an open source project, and we welcome contributions from anyone. However, when contributing to our repositories, you must follow the guidelines.
|
||||||
|
|
||||||
|
## Contributing a feature/fix
|
||||||
|
Before you contribute anything to our repositories, we would prefer if there is an open issue on the repository in question for the feature/fix you are going to contribute. This is not a requirement, but is preferred.
|
||||||
|
When commiting, your commits should follow the [Conventional Commits](https://conventionalcommits.org/) standard. (example: instead of `added xyz feature` do `feat: added xyz`)
|
||||||
|
Each repository may have its own code quality standards but the general overview is:
|
||||||
|
- Rust is preferred as a language for projects, although we are open to any language as long as it isn't too obscure.
|
||||||
|
- For databases, we always use PostgreSQL.
|
||||||
|
- For inter server communication, either gRPC or REST APIs may be used.
|
||||||
|
Adding tests to your code is not required at this time, but it is preferred you do.
|
||||||
|
|
||||||
|
## Licensing
|
||||||
|
Unless otherwise specified in the repository's own LICENSE file, all our code is licensed under the [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0), including that of outside contributions. By contributing to any repository (that does not have its own LICENSE file to agree to) in Spacebar, you agree to the terms of the GNU AGPLv3 license.
|
||||||
Loading…
Reference in a new issue