Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.85 KB

Contributing to Fellow Central

Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions. Please read through these guidelines carefully before submitting a PR or issue and let us know if it's not up-to-date (or even better, submit a PR with your proposed corrections 😉).

Please note we have a code of conduct, please follow it in all your interactions with the project.

Getting Started

This project contains a frontend, backend, and a discord bot. To get your development environment setup, read the README.md file of the corresponding project:

Get Started with:

REST API Docs:

Pull Requests

Pull requests are welcome!

You should open an issue to discuss your pull request, unless it's a trivial change. It's best to ensure that your proposed change would be accepted so that you don't waste your own time. If you would like to implement support for a significant feature that is not yet available, please talk to us beforehand to avoid any duplication of effort.

Pull requests should generally be opened against main.

Commits

Enter a properly formatted simple commit message when committing, such as:

git commit -m 'feat(frontend): add dashboard page'

Licensing

Fellow Central is MIT licensed. Contributions you submit will be released under that license.