2018-02-26 14:44:55 +00:00
|
|
|
Contributing Guide
|
|
|
|
|
==================
|
|
|
|
|
|
2020-08-22 05:47:11 +00:00
|
|
|
Thank you so much for taking the time to contribute in to htop!
|
2018-02-26 14:44:55 +00:00
|
|
|
|
|
|
|
|
Bug Reports
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Bug reports should be posted in the [Github issue
|
2020-08-22 05:47:11 +00:00
|
|
|
tracker](https://github.com/htop-dev/htop/issues).
|
|
|
|
|
Bug reports are extremely important since it's impossible for us to test
|
|
|
|
|
htop in every possible system, distribution and scenario. Your feedback
|
|
|
|
|
is what keeps the tool stable and always improving! Thank you!
|
2018-02-26 14:44:55 +00:00
|
|
|
|
|
|
|
|
Pull Requests
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Code contributions are most welcome! Just [fork the
|
2020-08-22 05:47:11 +00:00
|
|
|
repo](https://github.com/htop-dev/htop) and send a [pull
|
|
|
|
|
request](https://github.com/htop-dev/htop/pulls). Help is especially
|
|
|
|
|
appreciated for support of platforms other than Linux. If proposing new
|
2018-02-26 14:44:55 +00:00
|
|
|
features, please be mindful that htop is a system tool that needs to keep a
|
2020-08-22 05:47:11 +00:00
|
|
|
small footprint and perform well on systems under stress -- so unfortunately
|
|
|
|
|
we can't accept every new feature proposed, as we need to keep the tool slim
|
|
|
|
|
and maintainable. Great ideas backed by a PR are always carefully considered
|
|
|
|
|
for inclusion though! Also, PRs containing bug fixes and portability tweaks
|
|
|
|
|
are always included, please send those in!
|
2018-02-26 14:44:55 +00:00
|
|
|
|
|
|
|
|
Feature Requests
|
|
|
|
|
----------------
|
|
|
|
|
|
2021-05-14 09:29:29 +00:00
|
|
|
Please label Github issues that are feature requests with one of the `feature request`
|
|
|
|
|
labels. If you can't do this yourself, don't worry. The friendly folks from the
|
2021-05-14 09:17:35 +00:00
|
|
|
core team will distribute and fixup Github labels as part of the regular reviews.
|
2020-10-31 10:04:31 +00:00
|
|
|
|
|
|
|
|
Style Guide
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
To make working with the code easier a set of guidelines have evolved in
|
|
|
|
|
the past that new contributions should try to follow. While they are not set
|
|
|
|
|
in stone and always up for changes should the need arise they still provide
|
|
|
|
|
a first orientation to go by when contributing to this repository.
|
|
|
|
|
|
|
|
|
|
The details of the coding style as well as what to take care about with your
|
|
|
|
|
contributions can be found in our [style guide](docs/styleguide.md).
|
