From 0965a5f412202fb454c9256e4dd8631b3497cf95 Mon Sep 17 00:00:00 2001 From: Andreas Happe Date: Mon, 22 Apr 2024 12:57:55 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..429b460 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +## How to contribute to hackingBuddyGPT + +#### **Did you find a bug?** + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ipa-lab/hackingBuddyGPT/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ipa-lab/hackingBuddyGPT/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +#### **Did you write a patch that fixes a bug?** + +* Open a new GitHub pull request with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +#### **Do you intend to add a new feature or change an existing one?** + +* Suggest your change [as a new issue](https://github.com/ipa-lab/hackingBuddyGPT/issues) and start writing code in a new branch. + +Thanks! :heart: :heart: :heart: