cpufetch contributing guidelines

1. cpufetch does not accept pull requests
2. Creating an issue

Thanks for your interest in contributing to cpufetch! Please, read this page carefully to understand how to contribute to cpufetch.

1. cpufetch does not accept pull requests

cpufetch is a small project, and I enjoy developing it. There are for sure some bugs and exciting features to add, but I prefer to make these changes myself. For that reason, you should always use the issues page to report anything related to cpufetch. In the rare case that there is a concise bug or feature that I am unable to implement myself, I will enable pull requests for this.

2. Creating an issue

2.1: I found a bug in cpufetch (the program provides incorrect / invalid information)

In the github issue you must include:

Exact CPU model.
Operating system.
The output of cpufetch.
The output of cpufetch --debug.

2.2: I found a bug in cpufetch (the program crashes / does not work properly)

Exact CPU model.
Operating system.
The output of cpufetch.
The output of cpufetch --debug.
A stacktrace (if program crashes):

Stacktrace option 1 (best)

Build cpufetch with debug symbols (make clean; make debug).
Install valgrind (if it is not already installed)
Run cpufetch with valgrind (valgrind ./cpufetch)
Paste the complete output (preferably on a platform like pastebin)

Stacktrace option 2 (use this option if option 1 does not work)

Build cpufetch with debug symbols (make clean; make debug).
Install gdb (if it is not already installed)
Debug cpufetch with gdb (gdb cpufetch)
Run cpufetch (just r inside gdb console)
Paste the complete output (preferably on a platform like pastebin)

2.3: I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch

Just explain the feature in the issue and include references (links) to relevant sources if appropriate.

2.9 KiB Raw Permalink Blame History