Skip to content

Commit 0b9e49e

Browse files
committed
new: initial commit
0 parents  commit 0b9e49e

File tree

17 files changed

+992
-0
lines changed

17 files changed

+992
-0
lines changed

.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# virtual environment folder and related files
2+
venv/
3+
.env
4+
5+
# python generated binaries
6+
*__pycache__
7+
*__pycache__/
8+
9+
todo.md

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Project Name: Termii Python Library
2+
3+
# Version 1.0.0
4+
- Stable/Production Release

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
### Thank you for considering contributing to this project!
2+
3+
We welcome contributions of all kinds, from bug reports and feature requests to code improvements and new features.
4+
5+
#### Getting Started
6+
7+
- Fork the repository: Create a fork of the project on GitHub.
8+
- Clone your fork: Clone your forked repository to your local machine.
9+
- Create a new branch: Create a new branch for your feature or bug fix.  
10+
11+
12+
#### Coding Standards
13+
- Please adhere to the project's coding style (e.g., PEP 8).
14+
- Write clear and concise code with meaningful comments.
15+
- Test your changes thoroughly.
16+
17+
### Testing
18+
19+
Incase of adding tests to this project, we'd advice this be done using python's default unittest, inorder not to convulte the codebase.
20+
21+
22+
#### Submitting Your Contribution
23+
24+
- Commit your changes: Commit your changes with clear and descriptive commit messages.
25+
- Push to your fork: Push your changes to your forked repository.
26+
- Create a pull request: Open a pull request to the main repository, explaining your changes in detail.
27+
28+
29+
We appreciate your contributions!
30+
31+
Additional Tips:
32+
33+
- Consider using a linter to enforce code style consistency.
34+
- Provide clear and concise commit messages.
35+
- Be open to feedback and suggestions.
36+
- By following these guidelines, you can help improve the project for everyone.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Idenyi Gabriel
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)