Skip to content

Commit 28fc7ed

Browse files
Add contents
1 parent 51087e0 commit 28fc7ed

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
Want to contribute? You rock! But first, read these contributing guidelines to ensure your pull request is merged!
33

44
## Contents
5+
- [Creating a usefulib](#creating-a-usefulib)
6+
- [Typing your idea up](#typing-your-idea-up)
7+
- [Example of a usefulib](#example-of-a-usefulib)
8+
- [Writing tests](#writing-tests)
9+
- [Creating a test](#creating-a-test)
10+
- [Example of a test](#example-of-a-test)
11+
- [Opening A Pull Request](#opening-a-pull-request)
512

613
## Creating a usefulib
714
First, you need to come up with an idea for a usefulib. You need to try and keep it short but still make a task that would've taken more than two lines into one line. Make sure your idea is original by checking that someone hasn't already used your idea [here](https://github.com/hamdivazim/usefulib/blob/main/ALLFUNCTIONS.md). Then, it's time to get coding!
@@ -36,6 +43,7 @@ def reverse_string(string):
3643

3744
return string[::-1]
3845
```
46+
When you have added your usefulib, remember to add it to the list of [all usefulibs](https://github.com/hamdivazim/usefulib/blob/main/ALLFUNCTIONS.md).
3947

4048
## Writing tests
4149
Now that you've written your usefulib, you should test it! For this, naviagte to `tests.py` in the same directory. **Note:** this requires that you know how to write good unit tests in Python using `unittest`. If you don't know how to, watch this [awesome tutorial](https://www.youtube.com/watch?v=6tNS--WetLI) by Corey Schafer!

0 commit comments

Comments
 (0)