Skip to content
This repository has been archived by the owner on Nov 11, 2019. It is now read-only.

Commit

Permalink
Add to .gitignore and improve CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
willkg committed Feb 9, 2016
1 parent ffa7ba1 commit 1df867c
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 33 deletions.
51 changes: 47 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,50 @@
*.swp
*~
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

*.py[cod]
.ipynb_checkpoints
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
*.log

# Sphinx documentation
docs/_build/

# Editor things
*.swp
*~
84 changes: 55 additions & 29 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,82 @@
CONTRIBUTING
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:


Types of Contributions
======================

Bug reports
===========
-----------

File issues about incorrect data, things to add, etc here:
Report bugs at:

https://github.com/pyvideo/pyvideo-data/issues

.. Note::
If you are reporting a bug about incorrect data, please include:

All work is done on a volunteer basis, so if you write up an issue, it may
sit there forever.
* The directory, file or files that are relevant.
* The data that is incorrect.
* Values for the corrected data if you can provide them.

If you are reporting a bug about things to add, please include:

Working on issues in the issue tracker
======================================
* The name of the thing to add (the conference name, the user group name, etc).
* A description of the thing.
* Any urls where we can find additional details about the thing.
* The url for the video material.

Before working on issues in the issue tracker, please add a comment to the issue
stating that you're planning to work on it and any other details you think are
helpful to communicate with everyone else.
If you are reporting a bug about clive, please include:

For example::
* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

I'd like to work on this issue. If I don't hear from anyone in the next
couple of days, I'll work on it and submit a pull request.
.. Note::

Please remember that this is a volunteer-driven project!

All work is done on a volunteer basis, so if you write up an issue, it may
sit there for a while.

If you see an issue you can help with, please pitch in! If you don't, don't
expect anyone else to, either.


Then work on the task and produce a pull request.
Write Documentation
-------------------

Someone with authority will review the pull request and you'll go back and
forth with that person honing the data until it's good enough. At that point,
the person will merge it.
Our documentation can always be better. What questions did you have that you
think other people might have that aren't answered in the documentation? Were
you able to find what you were looking for? Was documentation in weird
unexpected places? Are there typos? Are examples helpful? Are examples missing?

We could always use more documentation whether that's part of the official
docs, comments and docstrings in the code or even elsewhere on the web in
blog posts, articles, tweets and other things like that.

Adding new conferences/files
============================

Before adding any new data, please create an issue for it in the issue tracker.
Fix bugs and implement new things in the software
-------------------------------------------------

Data is located in ``data/``.
Look through the issue tracker for bugs and features to work on. Anything that
is not assigned to someone is open to work on. Please comment in the issue about
your plans.

The top level of directories are by user group or conference. Directory names
are slugs.
For example::

Inside those directories, create one JSON file for each individual video.
I'd like to work on this issue. I think it should be fixed like this ...

<explanation>

Editing existing data
=====================
If I don't hear from anyone in the next couple of days, I'll work on it and
submit a pull request.

Before editing any data, please create an issue for it in the issue tracker.

Files can be edited with any editor. You can also write scripts. Make sure
any changes you make aren't destructive.
Want to work on something that isn't covered in an issue, yet? Please write one
up first. We don't want you to waste your time working on things that won't be
accepted.

0 comments on commit 1df867c

Please sign in to comment.