CONTRIBUTING.md

   1 # Introduction
   2
   3 ### Welcome!
   4
   5 First off, thank you for considering contributing to Homer!
   6
   7 ### Project philosophy
   8
   9 Homer is meant to be a light and very simple dashboard that keeps all your useful utilities at hands. The few features implemented in Homer focus on
  10 UX and usability. If you are looking for a full featured dashboard, there is tons of great stuff out there like https://heimdall.site/, https://github.com/rmountjoy92/DashMachine or https://organizr.app/.
  11
  12 - 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).
  13 - 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.
  14
  15
  16 # Ground Rules
  17
  18 ### Code of conduct and guidelines
  19
  20 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.
  21
  22 For all contributions, please respect the following guidelines:
  23
  24 * Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
  25 * Do not commit changes to files that are irrelevant to your feature or bugfix (e.g. `.gitignore`).
  26 * Do not add unnecessary dependencies.
  27 * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
  28
  29 # Getting started
  30
  31 ### Discuss about ideas
  32
  33 If you want to add a feature, it's often best to talk about it before starting to work on it and submitting a pull request. It's not mandatory at all, but
  34 feel free to open an issue to present your idea.
  35
  36 ### How to submit a contribution
  37
  38 The general process to submit a contribution is as follow:
  39 1. Take a look to the [development guideline](https://github.com/bastienwirtz/homer/blob/main/docs/development.md).
  40 2. Create your own fork of the code
  41 3. Do the changes in your fork
  42 4. Make sure to fill the [pull request description](https://github.com/bastienwirtz/homer/blob/main/.github/PULL_REQUEST_TEMPLATE.md) properly.
  43
  44 ### Happy coding :metal: