CONTRIBUTING.md

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, discord, or any other method with the owners of this repository before making a change.

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

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

How to Contribute

Setup your environment locally

Clone the repository to your local development environment

Create a .env file by copying the example .env file and declaring the variables within

Then, install the project's dependencies:

pnpm i

and run the project with :

pnpm run dev

Implement your changes

You should checkout a new branch with a name that is suitable to the work being completed:

git checkout -b "feat/<x>/branch name"

Then, you can commit changes to your branch:

git add <file> && git commit -m "commit message"

When you're done

Create a Pull Request on Github from your branch to main

Ensure that a suitable description is included, in addition to any relevant screenshots and other information