mirror of
https://github.com/taigrr/homer
synced 2025-01-18 04:53:12 -08:00
48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
# Introduction
|
|
|
|
### Welcome!
|
|
|
|
First off, thank you for considering contributing to Homer!
|
|
|
|
### Project philosophy
|
|
|
|
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
|
|
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/.
|
|
|
|
- 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.
|
|
|
|
For all contributions, please respect the following guidelines:
|
|
|
|
* 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.
|
|
* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).
|
|
* Do not add unnecessary dependencies.
|
|
* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
|
|
|
|
# Getting started
|
|
|
|
### Discuss about ideas
|
|
|
|
If you want to add a feature, it's often best to talk about it before starting working on it and submitting a pull request. It's not mandatory at all, but
|
|
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.
|
|
|
|
### Happy coding :metal:
|