Skip to content

Commit e475e9c

Browse files
Updated read me file
1 parent 40726de commit e475e9c

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1-
# python-stl-algorithm
2-
python functions matching STL algorithms
1+
# Python-stl-algorithm
2+
3+
I have created Python-stl-algorithm project purely for learning & fun purpose(as of now)
4+
5+
Python has a lot of inbuilt functions which makes it very powerful. We also know how useful CPP STL algorithms. This project is
6+
to add any STL functionality that is missing today in python. Even it is not in CPP STL you one thinks that it is good to have, feel free to add it.
7+
8+
To start with I have written few CPP STL algorithms and a test.py file for testing functions.
9+
10+
## Do's and Don'ts
11+
- Whole intention is to share knowledge hence try to clearly call out the purpose/functionality/use cases/limitations (if any) in the comment section in each function.
12+
- For better maintenance, it would be good to have one file for each category hence before creating any new file try to check if your function can be added into any of the existing files.
13+
- For every new function, one should have test cases which should cover negative and positive test case
14+
15+
## How can one contribute in the repository?
16+
This repository is open for anyone who has started learning python and wants to get his/her hands dirty. There is a number of ways one can contribute
17+
- Adding new functions
18+
- Adding new test cases for existing functions
19+
- Reporting bugs in existing code
20+
- By raising new feature requests.

0 commit comments

Comments
 (0)