dgraph-docs icon indicating copy to clipboard operation
dgraph-docs copied to clipboard

Set contribution rules (RFC)

Open MichelDiz opened this issue 3 years ago • 2 comments

Any modification outside of these rules the PR will be refused.

1 - TODO -> Indentation of DQL, GraphQL and other code needs to be standardized(e.g: Tabs vs spaces - we need choose one and why). Because there can be no indentation conflict, if each one imposes their own way of working it becomes a mess. Each one will, for example, want to "repair" the previous indentation at their pleasure. It is not right.

2 - Modifications to current documentation content should have a clear and objective reason. If it's just a typo, it's valid without explanation. But any amendment that changes the concept must be rejected. In that case, please create something new to add in alignment with the context. Or explain how and why the change is needed.

cc @skrdgraph

MichelDiz avatar Sep 29 '22 15:09 MichelDiz

Can we use some linter ? that can be applied and validated as a part of PR test ?

nswamy avatar Sep 29 '22 17:09 nswamy

Ideally, we should have standards and the contributor have knowledge about them. A linter and etc would just be a rearguard. We can have triggers from gh actions to ask for changes automatically.

MichelDiz avatar Sep 29 '22 18:09 MichelDiz

This issue has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.

github-actions[bot] avatar Jul 20 '24 01:07 github-actions[bot]