projects / github / bastienwirtz / homer.git / blame
| Commit | Line | Data |
|---|---|---|
| 22555b55 BW |
1 | # Introduction |
| 2 | ||
| 3 | ### Welcome! | |
| 4 | ||
| 5 | First off, thank you for considering contributing to Homer! | |
| 6 | ||
| 7 | ### Project philosophy | |
| 8 | ||
| 2662b170 | 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 |
| 22555b55 BW |
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 | ||
| 2662b170 | 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). |
| 22555b55 BW |
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 | ### Roadmap | |
| 16 | ||
| 17 | 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)! | |
| 18 | Feel free to open an issue if you have any question. | |
| 19 | ||
| 20 | # Ground Rules | |
| 21 | ||
| 22 | ### Code of conduct and guidelines | |
| 23 | ||
| 2662b170 | 24 | 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. |
| 22555b55 BW |
25 | |
| 26 | For all contributions, please respect the following guidelines: | |
| 27 | ||
| 28 | * 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. | |
| 86f4680a | 29 | * Do not commit changes to files that are irrelevant to your feature or bugfix (e.g. `.gitignore`). |
| 22555b55 BW |
30 | * Do not add unnecessary dependencies. |
| 31 | * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request. | |
| 32 | ||
| 33 | # Getting started | |
| 34 | ||
| 35 | ### Discuss about ideas | |
| 36 | ||
| 86f4680a | 37 | 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 |
| 22555b55 BW |
38 | feel free to open an issue to present your idea. |
| 39 | ||
| 40 | ### How to submit a contribution | |
| 41 | ||
| 42 | The general process to submit a contribution is as follow: | |
| 43 | 1. Create your own fork of the code | |
| 44 | 2. Do the changes in your fork | |
| 45 | 3. Make sure to fill the [pull request description](https://github.com/bastienwirtz/homer/blob/master/.github/PULL_REQUEST_TEMPLATE.md) properly. | |
| 46 | ||
| 47 | ### Happy coding :metal: |