Skip to content

Commit 4fe86db

Browse files
committed
update code of conduct and contributing
1 parent d5bdf1d commit 4fe86db

File tree

2 files changed

+28
-13
lines changed

2 files changed

+28
-13
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Our Pledge
44

5-
We as contributors and maintainers of the **XXX repository** pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
5+
We as contributors and maintainers of the **sql-data-guard repository** pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
66

77
We are committed to providing a welcoming and inspiring environment for all contributors, where constructive and respectful collaboration is prioritized.
88

CONTRIBUTING.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
1-
Describe in this file:
2-
3-
- team organization, roles, communication
4-
- the rules to be respected by your future contributors
5-
61
# Contributing guidelines
72

8-
## Team organization
9-
10-
### Roles
3+
We welcome contributions from everyone. To become a contributor, follow these steps:
114

12-
## How to become a contributor
13-
14-
### Contributor License Agreements
5+
1. Fork the repository.
6+
2. Create a new branch for your feature or bugfix.
7+
3. Make your changes.
8+
4. Submit a pull request.
159

1610
### Contributing code
1711

12+
When contributing code, please ensure that you follow our coding standards and guidelines. This helps maintain the quality and consistency of the codebase.
13+
1814
## Pull Request Checklist
1915

16+
Before submitting a pull request, please ensure that you have completed the following:
17+
18+
- [ ] Followed the coding style guidelines.
19+
- [ ] Written tests for your changes.
20+
- [ ] Run all tests and ensured they pass.
21+
- [ ] Updated documentation if necessary.
22+
2023
### License
2124

25+
By contributing to this project, you agree that your contributions will be licensed under the project's open-source license.
26+
2227
### Coding style
2328

2429
### Testing
2530

26-
#### Running sanity check
31+
All contributions must be accompanied by tests to ensure that the code works as expected and does not introduce regressions.
2732

2833
#### Running unit tests
34+
To run all the unit tests locally, use the following command:
35+
```sh
36+
sql-data-guard % PYTHONPATH=src python -m pytest --color=yes test/*_unit.py
37+
```
38+
Unit tests also run automatically on every push using a dedicated workflow.
39+
2940

3041
### Issues management
42+
43+
If you find a bug or have a feature request, please create an issue in the GitHub repository. Provide as much detail as possible to help us understand and address the issue.
44+
45+
We will review your issue and respond as soon as possible. Thank you for helping us improve the project!

0 commit comments

Comments
 (0)