-
-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation about contributing #227
Changes from 16 commits
439fbb9
037d5df
e310d12
f13bc56
2f1d95a
7cf6c7c
fe3a67e
14e9312
c61a561
d8bac59
2b439d4
9a09cfb
10a6118
46e6c61
b221441
1461163
ebf67f5
c3fb1ef
2769be2
c811ab9
e6f328b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Contributing | ||
============ | ||
|
||
Please see the [project documentation](http://zarr.readthedocs.io/en/stable/contributing.html) for information about contributing to Zarr. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<!-- | ||
|
||
For bug reports, please follow the template below. For enhancement proposals, feel free | ||
to use whatever template makes sense. | ||
|
||
--> | ||
|
||
#### Minimal, reproducible code sample, a copy-pastable example if possible | ||
|
||
```python | ||
# Your code here | ||
|
||
``` | ||
|
||
#### Problem description | ||
|
||
Explain why the current behavior is a problem, what the expected output/behaviour | ||
is, and why the expected output/behaviour is a better solution. | ||
|
||
#### Version and installation information | ||
|
||
Please provide the following: | ||
|
||
* Value of ``zarr.__version__`` | ||
* Value of ``numcodecs.__version__`` | ||
* Version of Python interpreter | ||
* Operating system (Linux/Windows/Mac) | ||
* How Zarr was installed (e.g., "using pip into virtual environment", or "using conda") | ||
|
||
Also, if you think it might be relevant, please provide the output from ``pip list`` or | ||
``conda list`` depending on which was used to install Zarr. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might suggest There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[Description of PR] | ||
|
||
TODO: | ||
* [ ] Unit tests and/or doctests in docstrings | ||
* [ ] ``tox -e py36`` passes locally | ||
* [ ] ``tox -e py27`` passes locally | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Personally I don't think we need to be so formal. Maybe something like this for the first one. Similar for the second. * [ ] Python 3.6 tests pass (e.g. ``tox -e py36``) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||
* [ ] Docstrings and API docs for any new/modified user-facing classes and functions | ||
* [ ] New/modified features documented in docs/tutorial.rst | ||
* [ ] Changes documented in docs/release.rst | ||
* [ ] ``tox -e docs`` passes locally | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar story as above. Here some comment about the docs building ok. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
* [ ] AppVeyor and Travis CI passes | ||
* [ ] Test coverage to 100% (Coveralls passes) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2015 Alistair Miles | ||
Copyright (c) 2018 Zarr Developers <https://github.com/zarr-developers> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should it be a range? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems good, but it doesn't show up currently (when rendered). Any reason for it to be commented?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, was just copying another example I'd seen.