Skip to content

Commit f6b0e87

Browse files
committed
added contribution guideline
1 parent c02e3f0 commit f6b0e87

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing Guidelines
2+
3+
Thank you for investing your time in contributing to our project! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community. Any contribution you make will be reflected on `github.com/FileXdb/FileXdb-Python`✨.
4+
5+
Contributions to _FileXdb_ are welcome! Here's how to get started:
6+
7+
- Open an [issue](https://github.com/FileXdb/FileXdb-Python/issues) or find for related issues to start a discussion around a feature idea or a bug.
8+
- Fork the [repository](https://github.com/FileXdb/FileXdb-Python) on GitHub.
9+
- Create a new branch of the master branch and start making your changes.
10+
- Make a meaning-full commit.
11+
- Write a test, which shows that the bug is fixed or the feature works as expected.
12+
- Send a pull request and wait until it gets merged and published.
13+
14+
15+
16+
# Coding Conventions
17+
18+
In general the FileXdb source code always follows [PEP 8](http://legacy.python.org/dev/peps/pep-0008/).
19+
Exceptions are allowed in well justified and documented cases. However, we make
20+
a small exception concerning docstrings:
21+
22+
When using multiline docstrings, keep the opening and closing triple quotes
23+
on their own lines and add an empty line after it.
24+
25+
Here is a demo for you.
26+
27+
```python
28+
29+
def sum_of_two_num(a: int, b: int ) -> int:
30+
"""
31+
Documentation ...
32+
33+
:param a: Definition...
34+
:param b: Definition...
35+
:return: Definition...
36+
"""
37+
38+
# Implementation Documentation ...
39+
result = a + b
40+
41+
return result
42+
```
43+
44+
45+
46+
# Version Numbers
47+
48+
FileXdb follows the [SemVer versioning guidelines](http://semver.org).
49+
This implies that backwards incompatible changes in the API will increment
50+
the major version. So think twice before making such changes.

0 commit comments

Comments
 (0)