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
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+
8
+
## Our Standards
9
+
10
+
Examples of behavior that contributes to creating a positive environment include:
11
+
12
+
* Using welcoming and inclusive language
13
+
* Being respectful of differing viewpoints and experiences
14
+
* Gracefully accepting constructive criticism
15
+
* Focusing on what is best for the community
16
+
* Showing empathy towards other community members
17
+
18
+
Examples of unacceptable behavior by participants include:
19
+
20
+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
21
+
* Trolling, insulting/derogatory comments, and personal or political attacks
22
+
* Public or private harassment
23
+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
24
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
25
+
26
+
27
+
## Our Responsibilities
28
+
29
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
30
+
31
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
32
+
33
+
34
+
## Scope
35
+
36
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
37
+
38
+
39
+
## Enforcement
40
+
41
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
42
+
43
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
44
+
45
+
46
+
## Attribution
47
+
48
+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+94-11Lines changed: 94 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,98 @@
1
-
# Contributions & Development
1
+
# Contributing Guide
2
2
3
-
## How to contribute
3
+
**Welcome to the webKnossos-libs contributing guide :sparkles:**
4
+
5
+
Thank you for taking the time to contribute to this project! The following is a set of guidelines for contributing to the different webKnossos related Python libraries, which are part of the [webKnossos-libs repository on GitHub](https://github.com/scalableminds/webknossos-libs). These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6
+
7
+
## Code of Conduct
8
+
9
+
webKnossos-libs and everyone contributing and collaborating on this project is expected to follow the [webKnossos-libs Code of Conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
10
+
11
+
12
+
## How can I help?
4
13
5
14
We welcome community feedback and contributions! We are happy to have
6
15
7
-
* general feedback and questions on the [image.sc forum](https://forum.image.sc/tag/webknossos),
8
-
* feature requests and bug reports as [issues on GitHub](https://github.com/scalableminds/webknossos-libs/issues/new),
9
-
* documentation, examples and code contributions as [pull requests on GitHub](https://github.com/scalableminds/webknossos-libs/compare).
16
+
*[general feedback, observations and questions](#feedback-observations-and-questions) on the [image.sc forum](https://forum.image.sc/tag/webknossos),
17
+
*[feature suggestions and bug reports](#issues-feature-suggestions-and-bug-reports) as [issues on GitHub](https://github.com/scalableminds/webknossos-libs/issues/new),
18
+
*[documentation, examples and code contributions](#pull-requests-docs-and-code-contributions) as [pull requests on GitHub](https://github.com/scalableminds/webknossos-libs/compare).
19
+
20
+
21
+
## Feedback, Observations and Questions
22
+
23
+
We'd love to hear your feedback on the webKnossos Python libraries!
24
+
We're also interested in hearing if these tools don't work for your usecase,
25
+
or if you have questions regarding their usage.
26
+
27
+
Please leave a message on the [image.sc forum](https://forum.image.sc/tag/webknossos)
28
+
using the `webknossos` tag to enable public communication on those topics.
29
+
If you prefer to share information only with the webKnossos team, please write an email
reach out to [scalable minds](https://scalableminds.com).
32
+
33
+
34
+
## Issues: Feature Suggestions and Bug Reports
35
+
36
+
We track feature requests and bug reports in the [webKnossos-libs repository issues](https://github.com/scalableminds/webknossos-libs/issues).
37
+
Before opening a new issue, please do a quick search of existing issues to make sure your suggestion hasn’t already been added.
38
+
If your issue doesn’t already exist, and you’re ready to create a new one, make sure to state what you would like to implement, improve or bugfix.
39
+
Please use one of the provided templates to make this process easier for you.
40
+
41
+
You can submit an issue [here](https://github.com/scalableminds/webknossos-libs/issues/new)
42
+
(read more about [issues here](https://docs.github.com/en/issues)).
43
+
44
+
45
+
### Report a Bug :lady_beetle:
46
+
47
+
When you find a bug, please double-check if an issue for the same bug exists already.
48
+
If that's not the case, please verify in the [documentation](https://docs.webknossos.org/api/webknossos.html)
49
+
that you use the API as intended. If that's the case, please
50
+
[add an issue using the bug report template](https://github.com/scalableminds/webknossos/issues/new?template=bug_report.md).
51
+
52
+
53
+
### Suggest a New Feature
54
+
55
+
If you are missing a feature to support your use-case, please consider the following points:
56
+
57
+
1. Please verify if this feature is directly related to webKnossos.
58
+
Does it belong into the webKnossos Python libraries?
59
+
2. Double-check if an issue for this feature exists already. If there is one with a very similar scope,
60
+
please considering commenting there.
61
+
3. If possible, consider how the implementation might look like (e.g. how would the public API change),
62
+
as well as how this could be tested and presented in the examples.
63
+
64
+
Then, please [add an issue using the feature suggestion template](https://github.com/scalableminds/webknossos/issues/new?template=feature_suggestion.md).
65
+
66
+
67
+
## Pull Requests: Docs and Code Contributions
68
+
69
+
This project welcomes contributions and suggestions. Most contributions require you to
70
+
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
71
+
and actually do, grant us the rights to use your contribution. For details, visit
To install the dependencies for all sub-projects, run `make install`.
33
-
***Tooling** we use across the sub-projects:
116
+
***Tooling** we use across the sub-projects to enforce coding styles and tests:
34
117
*`format.sh`: black and isort
35
118
*`lint.sh`: pylint
36
119
*`typecheck.sh`: mypy
@@ -49,7 +132,7 @@ Internal workflows for scalable minds:
49
132
This updates the changelog and pushes a new tag, which triggers another CI run building and publishing the package.
50
133
51
134
52
-
### `webknossos` package
135
+
####`webknossos` package
53
136
54
137
The `webknossos` folder contains examples, which are not part of the package, but are tested via `tests/test_examples.py` and added to the documentation (see `docs/src/webknossos-py/examples`).
55
138
@@ -69,7 +152,7 @@ To re-generate the code, run
69
152
```
70
153
71
154
72
-
### `wkcuber` package
155
+
####`wkcuber` package
73
156
74
157
Currently the test setup consists of different scripts as well as pytest tests. The following commands are run in CI:
75
158
```bash
@@ -81,14 +164,14 @@ poetry run tests/scripts/all_tests.sh
81
164
There is also a `test.sh` which is currently outdated, see [issue #580](https://github.com/scalableminds/webknossos-libs/issues/580).
82
165
83
166
84
-
### `cluster_tools` package
167
+
####`cluster_tools` package
85
168
86
169
For testing the `slurm` setup a docker-compose setup is available. Please see the [respective Readme](https://github.com/scalableminds/webknossos-libs/blob/master/cluster_tools/README.md) for details.
87
170
88
171
For testing the `kubernetes` setup, we recommend a [Kubernetes-in-Docker setup](https://kind.sigs.k8s.io/).
89
172
90
173
91
-
## Documentation
174
+
###Documentation
92
175
93
176
We render a common documentation for webKnossos itself and webknossos-libs from this repository using [mkdocs](https://www.mkdocs.org/). Source-files for the documentation are stored at `docs/src`:
0 commit comments