Skip to content

Commit 42dd6a2

Browse files
authored
Create CONTRIBUTING.md
1 parent 35a7554 commit 42dd6a2

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CONTRIBUTING.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to exponential_back_off
2+
3+
First off, thanks for taking the time to contribute! ❤
4+
5+
> if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
6+
> - Star the project
7+
> - Tweet about it
8+
> - Refer this project in your project's readme
9+
> - Mention the project at local meetups and tell your friends/colleagues
10+
11+
## I Want To Contribute
12+
13+
> ### Legal Notice
14+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
15+
16+
### Reporting Bugs
17+
18+
19+
#### Before Submitting a Bug Report
20+
21+
A good bug report shouldn't leave others needing to chase you up for more information. So, we'd like to ask you to investigate carefully, collect information, and describe the issue in detail in your report. Please complete the following steps to help us quickly fix any potential bug.
22+
23+
- Make sure that you are using the latest version.
24+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](README.md).
25+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Nidal-Bakir/exponential_back_off/issues?q=).
26+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
27+
- Collect information about the bug:
28+
- Stack trace (Traceback)
29+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
30+
- Version of the interpreter, compiler, SDK, runtime environment, and package manager, depending on what seems relevant.
31+
- Possibly your input and the output
32+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
33+
34+
35+
#### How Do I Submit a Good Bug Report?
36+
>[!CAUTION]
37+
> You must never report security-related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].
38+
39+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
40+
41+
- Open an [Issue](https://github.com/Nidal-Bakir/exponential_back_off/issues/new/choose). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
42+
- Explain the behavior you would expect and the actual behavior.
43+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
44+
- Provide the information you collected in the previous section.
45+

0 commit comments

Comments
 (0)