X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=CONTRIBUTING.md;h=de893b6c7e512649b13ef44e1613e76e4b8f0059;hb=e3b68ddc427a62fb77acd709b2dbdc8681c49158;hp=a744c8afa408ff3101e1fe1a141e1f041dd21c59;hpb=a2e28229a90d3f1adb10cc256cc14b4d48d50c42;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a744c8a..de893b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,16 +12,12 @@ UX and usability. If you are looking for a full featured dashboard, there is ton - Configuration is stored in a simple config file, avoiding the need for a backend/database while making possible to use versioning or [config template](https://docs.ansible.com/ansible/latest/user_guide/playbooks_templating.html). - Only modern browsers are supported, feel free to use any JS features without any polyfill as soon as the latest version of the major browsers supports them. -### Roadmap - -If you want to know more about the project direction or looking for something to work on, checkout the [roadmap](https://github.com/bastienwirtz/homer#Roadmap)! -Feel free to open an issue if you have any question. # Ground Rules ### Code of conduct and guidelines -First of all, we expect everyone (contributors and maintainers alike) to respect the [Code of conduct](https://github.com/bastienwirtz/homer/blob/master/CODE_OF_CONDUCT.md). It is not a recommendation, it is mandatory. +First of all, we expect everyone (contributors and maintainers alike) to respect the [Code of conduct](https://github.com/bastienwirtz/homer/blob/main/CODE_OF_CONDUCT.md). It is not a recommendation, it is mandatory. For all contributions, please respect the following guidelines: @@ -40,8 +36,9 @@ feel free to open an issue to present your idea. ### How to submit a contribution The general process to submit a contribution is as follow: -1. Create your own fork of the code -2. Do the changes in your fork -3. Make sure to fill the [pull request description](https://github.com/bastienwirtz/homer/blob/master/.github/PULL_REQUEST_TEMPLATE.md) properly. +1. Take a look to the [development guideline](https://github.com/bastienwirtz/homer/blob/main/docs/development.md). +2. Create your own fork of the code +3. Do the changes in your fork +4. Make sure to fill the [pull request description](https://github.com/bastienwirtz/homer/blob/main/.github/PULL_REQUEST_TEMPLATE.md) properly. ### Happy coding :metal: