## How to contribute By participating in this project, you agree to abide by the [code of conduct](CODE_OF_CONDUCT.md) ### Getting Started 1. Fork, then clone the repo: ```bash git clone git@github.com:your-username/ramme.git ``` 2. Install the project dependencies: ```bash 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. ```bash # 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](https://github.com/terkelg/ramme/compare/) 6. Wait or mention someone to review your pull request. ### Additional Resources * [How to write a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) * [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) * [General GitHub documentation](https://help.github.com/) * [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) * [Github requesting a pull request review documentation](https://help.github.com/articles/requesting-a-pull-request-review/) ## Financial contributions We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/ramme). 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](https://opencollective.com/ramme#backer)] ### Sponsors Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/ramme#sponsor))