CONTRIBUTING.md

How to contribute

By participating in this project, you agree to abide by the code of conduct

Getting Started

1. Fork, then clone the repo:

git clone [e-mail]:your-username/ramme.git

2. Install the project dependencies:

cd ramme

# Using yarn
yarn install

# OR

# Using NPM
npm install

3. Make your change.

4. Start the app, test your change, make sure it is working as expected.

# Using yarn
yarn dev

# OR

# Using NPM
npm run dev

5. After confirming the correctness of your change, push it to your fork and submit a pull request

6. Wait or mention someone to review your pull request.

Additional Resources

• How to write a good commit message

• How to write the perfect pull request

• General GitHub documentation

• GitHub pull request documentation

• Github requesting a pull request review documentation

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to ramme!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)