Skip to content
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

Merged
merged 21 commits into from
Jan 29, 2018
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
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.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE.md
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.
Copy link
Member

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?

Copy link
Member Author

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.


-->

#### 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might suggest conda env export and pip freeze instead. These produce files that can be used to immediately install a user's environment and begin playing with it. While conda list and pip list do provide the same info, there is no one liner that turns them into an environment on a dev's machine.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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
Copy link
Member

Choose a reason for hiding this comment

The 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``)

Copy link
Member Author

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar story as above. Here some comment about the docs building ok.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* [ ] AppVeyor and Travis CI passes
* [ ] Test coverage to 100% (Coveralls passes)
2 changes: 1 addition & 1 deletion LICENSE
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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be a range?

Copy link
Member Author

Choose a reason for hiding this comment

The 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
Expand Down
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ more information.
.. image:: https://readthedocs.org/projects/zarr/badge/?version=latest
:target: http://zarr.readthedocs.io/en/latest/?badge=latest

.. image:: https://travis-ci.org/alimanfoo/zarr.svg?branch=master
:target: https://travis-ci.org/alimanfoo/zarr
.. image:: https://travis-ci.org/zarr-developers/zarr.svg?branch=master
:target: https://travis-ci.org/zarr-developers/zarr

.. image:: https://ci.appveyor.com/api/projects/status/7d4iko59k8hpbbik?svg=true
:target: https://ci.appveyor.com/project/alimanfoo/zarr
:target: https://ci.appveyor.com/project/zarr-developers/zarr

.. image:: https://coveralls.io/repos/github/alimanfoo/zarr/badge.svg?branch=master
:target: https://coveralls.io/github/alimanfoo/zarr?branch=master
.. image:: https://coveralls.io/repos/github/zarr-developers/zarr/badge.svg?branch=master
:target: https://coveralls.io/github/zarr-developers/zarr?branch=master
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def __getattr__(cls, name):

numpydoc_show_class_members = False
numpydoc_class_members_toctree = False
issues_github_path = 'alimanfoo/zarr'
issues_github_path = 'zarr-developers/zarr'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -78,8 +78,8 @@ def __getattr__(cls, name):

# General information about the project.
project = 'zarr'
copyright = '2016, Alistair Miles'
author = 'Alistair Miles'
copyright = '2018, Zarr Developers'
author = 'Zarr Developers'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -258,7 +258,7 @@ def __getattr__(cls, name):
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'zarr.tex', 'zarr Documentation',
'Alistair Miles', 'manual'),
'Zarr Developers', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down
Loading