From c04dd86523d2ef48b4c7546ba3b164b4acaa4f68 Mon Sep 17 00:00:00 2001 From: Dr-Noob Date: Sun, 18 Apr 2021 20:49:16 +0200 Subject: [PATCH] [v0.97] Add issues section to contributig file --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a5f763..b90e340 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,51 @@ -# Contributing to cpufetch +# cpufetch contributing guidelines + + + + + +- [Creating a pull request](#creating-a-pull-request) + - [Case 1: I found a bug in cpufetch](#case-1-i-found-a-bug-in-cpufetch) + - [Case 2: I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch](#case-2-i-have-an-idea-for-a-new-feature-in-cpufetch--i-want-to-suggest-a-change-in-cpufetch) + - [Case 3: I want to make changes to the Makefile](#case-3-i-want-to-make-changes-to-the-makefile) +- [Creating an issue](#creating-an-issue) + - [cpufetch fails / crashes with a segmentation fault / ends without any output](#cpufetch-fails--crashes-with-a-segmentation-fault--ends-without-any-output) + - [Option 1 (best)](#option-1-best) + - [Option 2 (use this option if you can't work with option 1)](#option-2-use-this-option-if-you-cant-work-with-option-1) + + + +## Creating a pull request Thanks for your interest in contributing to cpufetch! What kind of contribution are you going to propose? -## I found a bug in cpufetch +### 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. -## I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch +### 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. -## I want to make changes to the Makefile +### 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) +1. Build cpufetch with debug symbols (`make clean; make debug`). +2. Install valgrind (if it is not already installed) +3. Run cpufetch with valgrind (`valgrind ./cpufetch`) +4. Paste the complete output (preferably on a platform like pastebin) + +#### Option 2 (use this option if you can't work with option 1) +1. Build cpufetch with debug symbols (`make clean; make debug`). +2. Install gdb (if it is not already installed) +3. Debug cpufetch with gdb (`gdb cpufetch`) +3. Run cpufetch (just r inside gdb console) +4. Paste the complete output (preferably on a platform like pastebin)