Skip to content

Commit 4e85778

Browse files
committed
Add contributing guide
Fixes #391
1 parent ef6b7b5 commit 4e85778

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing Guidelines
2+
3+
There are two main ways to contribute to the project — submitting issues and submitting
4+
fixes/changes/improvements via pull requests.
5+
6+
## Issue Submission
7+
8+
Please file the issues [here](https://github.com/Kotlin/kotlin-jupyter-libraries/issues).
9+
10+
General types of issues in this project:
11+
- Descriptor for some library needs to be added
12+
- The library is obsolete and needs to be removed
13+
- The library version is out-of-date
14+
- Descriptor is broken and needs to be fixed
15+
16+
## Submitting Pull Requests
17+
18+
We welcome Pull Requests.
19+
You can submit them [here](https://github.com/Kotlin/kotlin-jupyter-libraries/pulls).
20+
21+
Some rules apply to the pull requests:
22+
- If the pull request fixes an issue, please mention it in the pull request title and in the commit message, i.e.
23+
`Fix #123`
24+
- If the pull request adds a new library, please check the following things:
25+
- `description` and `link` are present in the descriptor. We generate the list of libraries using these values
26+
so ensure they are correct
27+
- `properties` property is present in the descriptor. It should include all versions of Maven dependencies that are
28+
used in `dependencies` section. It should also include hints for the auto-update of these dependencies. I.e.:
29+
```json
30+
{
31+
"properties": [
32+
{ "name": "v", "value": "0.1.2" },
33+
{ "name": "v-renovate-hint", "value": "update: package=<group>:<artifact>" }
34+
]
35+
}
36+
```
37+
- at least one dependency is present in the `dependencies` list. Version should be a property reference, i.e.
38+
`<group>:<artifact>:$v`
39+
- Other rules and approaches could be found in [this guide](https://github.com/Kotlin/kotlin-jupyter/blob/master/docs/libraries.md)
40+
41+
## Contacting maintainers
42+
43+
If you encounter any issues or have questions about the project, there are several ways to contact the maintainers:
44+
45+
* Submit an [issue](#issue-submission) on GitHub to report a bug or request a new feature.
46+
* Mention the maintainer (@ileasile) on GitHub to draw their attention
47+
to a specific problem or ask a question.
48+
* For general inquiries and discussions, use the `#notebooks` channel on
49+
the [KotlinLang Slack](https://kotl.in/slack).

0 commit comments

Comments
 (0)