Skip to content

Commit bdb6ee3

Browse files
committed
docs: simplify README and align docs terminology around policy gate
1 parent 5191c42 commit bdb6ee3

16 files changed

Lines changed: 568 additions & 251 deletions

CONTRIBUTING.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
# datafog contributing guidelines
1+
# Contributing to DataFog
22

3-
The datafog community appreciates your contributions via issues and
4-
pull requests. Note that the [code of conduct](CODE_OF_CONDUCT.md)
5-
applies to all interactions with the datafog project, including
6-
issues and pull requests.
3+
DataFog welcomes contributions via issues and pull requests. The [Code of Conduct](CODE_OF_CONDUCT.md) applies to all project interactions, including issues and PRs.
4+
5+
When submitting a pull request:
6+
7+
- Follow project style guidelines.
8+
- Ensure tests and docs are updated where behavior changes.
9+
- Keep commit messages clear and descriptive.
10+
- Confirm your work is covered by a compatible license in line with the project [`LICENSE`](LICENSE).
711

8-
When submitting pull requests, please follow the style guidelines of
9-
the project, ensure that your code is tested and documented, and write
10-
good commit messages, e.g., following [these
11-
guidelines](https://chris.beams.io/posts/git-commit/).
1212

13-
By submitting a pull request, you are licensing your code under the
14-
project [license](LICENSE) and affirming that you either own copyright
15-
(automatic for most individuals) or are authorized to distribute under
16-
the project license (e.g., in case your employer retains copyright on
17-
your work).

0 commit comments

Comments
 (0)