holm/homer
1
0
Fork 0
forked from extern/homer
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a74fa38302
homer/CONTRIBUTING.md
Bastien Wirtz 71a7d3cce4 Fix documentation link.
2020-12-07 22:57:44 -08:00

2.4 KiB
Raw Blame History

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.
  • 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! 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. 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 (e.g. .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 to work 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 properly.

Happy coding 🤘