2.7 KiB
cpufetch contributing guidelines
Creating a pull request
Thanks for your interest in contributing to cpufetch!
What kind of contribution are you going to propose?
Case 1: I found a bug in cpufetch
If you found a bug, please don't open a pull request; open an issue instead, even if you know the solution. I appreciate people finding bugs, but I generally prefer to fix them myself.
Case 2: I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch
Great! Make a PR and make sure to explain how did you implement your new feature on the github conversation page.
Case 3: I want to make changes to the Makefile
Don't open a pull request; open an issue instead and suggest your changes in the Makefile there. Except for extraordinary cases, I will not accept changes in the Makefile.
Creating an issue
If you are going to report a bug or problem, always report the CPU model and OS. If possible, also paste the output of cpufetch and cpufetch --debug.
cpufetch fails / crashes with a segmentation fault / ends without any output
You need to provide additional information in the github issue:
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)
Option 2 (use this option if you can't work with option 1)
- 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)