Skip to content

Commit 5c3d858

Browse files
authored
📝 update CONTRIBUTING.md
1 parent 0b8640a commit 5c3d858

File tree

1 file changed

+34
-26
lines changed

1 file changed

+34
-26
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
11
# Contributing
22

3-
I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
3+
I greatly appreciate your interest in reading this message, as this project requires volunteer developers to assist
4+
in developing and maintaining it.
45

5-
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other
6-
method with the owners of this repository before making a change.
6+
Before making any changes to this repository, please first discuss the proposed modifications with the repository owners
7+
through an issue, email, or any other appropriate communication channel.
78

8-
Please note we have a code of conduct, please follow it in all your interactions with the project.
9+
Please be aware that a [code of conduct](CODE-OF-CONDUCT.md) is in place, and should be adhered to during all
10+
interactions related to the project.
911

1012
## Python version support
1113

12-
Backwards compatibility is a must.
14+
Ensuring backward compatibility is an imperative requirement.
1315

14-
Currently, the tool supports Python versions 2.7, 3.5, 3.6, 3.7, 3.8, 3.9 and 3.10.
16+
Currently, the tool supports Python versions 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11.
1517

16-
Even though Python 2.7 has reached the end of its life at the beginning of 2020, a lot of people still rely on it.
17-
Therefore, we should continue to support it as long as the underlying tools do not completely drop support for it.
18+
Despite the fact that Python 2.7 has indeed reached the conclusion of its lifecycle in early 2020, a considerable number
19+
of individuals still rely heavily upon it. Consequently, it is incumbent upon us to maintain our support for this
20+
version until such time as the fundamental tools unequivocally discontinue their backing for it.
1821

1922
## MySQL version support
2023

21-
This tool supports and should continue to support MySQL versions 5.5, 5.6, 5.7 and 8.0. This includes any includes major
22-
forks of MySQL, e.g. MariaDB.
24+
This tool is intended to fully support MySQL versions 5.5, 5.6, 5.7, and 8.0, including major forks like MariaDB.
25+
We should prioritize and be dedicated to maintaining compatibility with these versions for a smooth user experience.
2326

2427
## Testing
2528

26-
Since this project/tool deals with transferring data from one database type to another it is crucial that it is
27-
thoroughly tested. Please write tests for any new code you create. All tests must be written using [pytest](https://docs.pytest.org/en/latest/).
29+
As this project/tool involves the critical process of transferring data between different database types, it is of
30+
utmost importance to ensure thorough testing. Please remember to write tests for any new code you create, utilizing the
31+
[pytest](https://docs.pytest.org/en/latest/) framework for all test cases.
2832

2933
### Running the test suite
3034

@@ -56,14 +60,17 @@ tox
5660

5761
## Submitting changes
5862

59-
Send a new [pull request](https://github.com/techouse/sqlite3-to-mysql/pull/new/master) with a clear list of what
60-
you've done (read more about [pull requests](http://help.github.com/pull-requests/)). When you send a pull request,
61-
we will love you forever if you include [pytest]((https://docs.pytest.org/en/latest/)) tests. We can always use more
62-
test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature
63-
per commit).
63+
To contribute to this project, please submit a
64+
new [pull request](https://github.com/techouse/sqlite3-to-mysql/pull/new/master) and provide a clear list of your
65+
modifications. For guidance on creating pull requests, you can refer
66+
to [this resource](http://help.github.com/pull-requests/).
6467

65-
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes
66-
should look like this:
68+
When sending a pull request, we highly appreciate the inclusion of [pytest](https://docs.pytest.org/en/latest/) tests,
69+
as we strive to enhance our test coverage. Following our coding conventions is essential, and it would be ideal if you
70+
ensure that each commit focuses on a single feature.
71+
72+
For commits, please write clear log messages. While concise one-line messages are suitable for small changes, more
73+
substantial modifications should follow a format similar to the example below:
6774

6875
```bash
6976
git commit -m "A brief summary of the commit
@@ -73,17 +80,18 @@ git commit -m "A brief summary of the commit
7380

7481
## Coding standards
7582

76-
Your code should be readable and concise. Always use [Black](https://github.com/psf/black) to format your code.
77-
Additionally, once you feel you're done, run
83+
It is essential to prioritize code readability and conciseness. To achieve this, we recommend
84+
using [Black](https://github.com/psf/black) for code formatting.
85+
86+
Once your work is deemed complete, it is advisable to run the following command:
7887

7988
```bash
8089
tox -e flake8,linters
81-
```
82-
83-
in order to run all various linters and checkers against it.
84-
90+
```
8591

92+
This command executes various linters and checkers to identify any potential issues or inconsistencies in your code. By
93+
following these guidelines, you can ensure a high-quality codebase.
8694

8795
Thanks,
8896

89-
Klemen Tusar
97+
Klemen Tusar

0 commit comments

Comments
 (0)