CONTRIBUTING.rst 3.22 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
============
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
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at issues_.

If you are reporting a bug, please include:

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

Fix Bugs
~~~~~~~~

28
Look through the GitLab issues for bugs.
29
30
31
32
33
Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

34
Look through the GitLab issues for
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

**treex** could always use more documentation, whether as
part of the official **treex** docs, in docstrings, or even
on the web in blog posts, articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at issues_.

If you are proposing a feature:

  * Explain in detail how it would work.
  * Keep the scope as narrow as possible, to make it easier to implement.
  * Remember that this is a volunteer-driven project, and that contributions
    are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `treex` for local
development.

62
1. Fork the `treex` repo on GitLab.
63
64
2. Clone your fork locally::

CERUTTI Guillaume's avatar
CERUTTI Guillaume committed
65
    $ git clone git@gitlab.inria.fr:mosaic/treex.git
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    
3. Install your local copy into a virtualenv. Assuming you have virtualenv_
installed, this is how you set up your fork for local development::

    $ virtualenv dvlpt
    $ dvlpt/script/activate
    (dvlpt)$ python setup.py develop

4. Create a branch for local development (wip stands for work in progress)::

    (dvlpt)$ git checkout -b wip_name-of-your-bugfix-or-feature

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

    (dvlpt)$ cd treex
    (dvlpt) treex$ flake8
    (dvlpt) treex$ nosetests
    
    (dvlpt) treex$ tox

   To get flake8 and tox, just pip install them into your virtualenv.

91
6. Commit your changes and push your branch to GitLab
92
93
94
95
96
97
::

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin wip_name-of-your-bugfix-or-feature

98
7. Submit a pull request through the GitLab website.
99
100
101
102
103
104
105
106
107
108
109

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put
     your new functionality into a function with a docstring, and add the
     feature to the list in README.rst.
  3. The pull request should work for Python 36.
CERUTTI Guillaume's avatar
CERUTTI Guillaume committed
110
     Check `Travis <https://travis-ci.org/mosaic/treex/pull_requests>`_
111
112
113
114
115
116
117
118
119
120
121
122
123
124
     and make sure that the tests pass for all supported Python versions.
     

Tips
----


To run a subset of tests::

    $ nosetests test/test_XXX




CERUTTI Guillaume's avatar
CERUTTI Guillaume committed
125
.. _issues: https://gitlab.inria.fr/mosaic/treex/issues
126
127

.. _virtualenv: https://pypi.python.org/pypi/virtualenv