Merge pull request #553 from neo4j/rename-developing

Rename developing.md to contributing.md

Author: angrykoala

CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# CONTRIBUTING
+
+All contributions, such as [issues](https://github.com/neo4j/cypher-builder/issues) and [pull requests](https://github.com/neo4j/cypher-builder/pulls) are welcome.
+
+If you want to contribute code, make sure to [sign the CLA](https://neo4j.com/developer/contributing-code/#sign-cla).
+
+## Development instructions
+
+- `npm test` to run cypher builder tests. Most tests are located next to the code that are testing as a `.test.ts` file
+- `npm run build` to compile cypher builder library
+- `npm run docs` to generate the API reference docs
+- `npm run changeset` to generate changelog files of the changes
+
+### Link Cypher Builder locally with yarn
+
+In the Cypher Builder folder run:
+
+- `yarn link`
+- `yarn build`
+
+In the root of the package run:
+
+- `yarn link -p [path-to-local-cypher-builder]`
+
+To unlink, in the project using cypher-builder:
+
+- `yarn unlink @neo4j/cypher-builder`
+
+### TSDoc references
+
+Each public element of the library should have a TSDoc comment compatible with [TypeDoc](https://typedoc.org/guides/overview).
+The comments should follow these conventions:
+
+- Brief description if needed
+- @group - This should be the Cypher concept related to this interface: Functions, Clauses, Operators, Procedures, Subqueries, Patterns, Namespaces, Maps, Lists, Utils.
+- @category - Sub grouping, if needed. For example, `Aggregations` inside the group `functions`,
+- @see {@link https://neo4j.com/docs/cypher-manual | Cypher Documentation} - A link to the element in the Cypher documentation,
+- @internal - If used by the library and not exposed,
+- @example - Example of usage and resulting Cypher, in markdown,
+- @since - If recently added to Neo4j: `@since Neo4j 5.19`,
+- @deprecated - If deprecated in Cypher Builder,
+
+For example:
+
+```ts
+/** Absolute value of an Integer or Float
+ * @group Functions
+ * @category Math
+ * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-abs | Cypher Documentation}
+ */
+export function abs(expr: Expr): CypherFunction {}
+```
+
+#### Files
+
+- `tsdoc.json` Defines the tsdoc shcema
+- `typedoc.json` Configures the tool typedoc

DEVELOPING.md

@@ -42,6 +42,10 @@ _Params_
 }
 ```
 
+# Contributing
+
+See our [contributing guide](./CONTRIBUTING.md) for development instructions.
+
 # Examples
 
 You can find usage examples in the [examples](https://github.com/neo4j/cypher-builder/tree/main/examples) folder.