You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+19-5Lines changed: 19 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -33,11 +33,25 @@ You will still need to refresh the page to view the changes.
33
33
[[contributing]]
34
34
== Contributing
35
35
36
-
To make changes to this repository, please create a fork of this repo and a new branch to stage your changes.
37
-
Your branch should be prefixed with the version number, for example, `dev-new-examples`.
38
-
39
-
When you are finished with your changes push the branch to your fork and create a Pull Request.
40
-
Please add at least one approver.
36
+
. To make changes to this repository, create a fork of this repo and a new branch to stage your changes.
37
+
Your branch should be prefixed with `dev-` or the version if it is a specific version you are working on.
38
+
. If you want to add a new GQLSTATUS code or update an existing one, you must start with the `neo4j` repo.
39
+
The `neo4j` repo is the source of truth for all GQLSTATUS codes.
40
+
. Add a page for each new GQLSTATUS code in the _docs-status-codes/modules/ROOT/pages/errors/gql-errors_ folder or update an existing one.
41
+
The file name should be the same as the GQLSTATUS code, e.g., `08N02.adoc` for the `08N02` code.
42
+
Use the same format as the other files in this folder.
43
+
. Update the _content-nav.adoc_ file to reflect the added codes.
44
+
Codes are ordered alphabetically.
45
+
. If the standard description of a new GQLSTATUS code contains a new parameter, add this parameter to the _docs-status-codes/modules/ROOT/partials/glossary.adoc_ file as well.
46
+
. GQLSTATUS codes are also listed on the index page.
47
+
PLEASE DON’T EDIT IT.
48
+
The _docs-status-codes/modules/ROOT/pages/errors/gql-errors/index.adoc_ file is created from a template and the codes and their status descriptions are automatically populated.
49
+
If you want to update the index page with adding a new section or section description, please contact the Docs team.
50
+
The Docs team is also responsible for keeping it consistent with the individual error files.
51
+
. If possible, add an example of the new error and any extra information our users may benefit from on the error page.
52
+
See the following pages for inspiration:
53
+
https://neo4j.com/docs/status-codes/current/errors/gql-errors/08N02/, https://neo4j.com/docs/status-codes/current/errors/gql-errors/08N07/, and https://neo4j.com/docs/status-codes/current/errors/gql-errors/51N27/.
54
+
. Let your team and Docs team review the PR.
41
55
42
56
[[guidelines]]
43
57
== Guidelines for writing errors and notifications
0 commit comments