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
28
29
30
31
32
33
34
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
62
63
64
65
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
Contributing Guidelines
=======================
Questions, Feature Requests, Bug Reports, and Feedback…
-------------------------------------------------------
…should all be reported on the `GitHub Issue Tracker`_ .
.. _`GitHub Issue Tracker`: https://github.com/marshmallow-code/flask-marshmallow/issues?state=open
Contributing Code
-----------------
In General
++++++++++
- `PEP 8`_, when sensible.
- Test ruthlessly. Write docs for new features.
- Even more important than Test-Driven Development--*Human-Driven Development*.
.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
In Particular
+++++++++++++
Setting Up for Local Development
********************************
1. Fork flask-marshmallow_ on GitHub.
::
$ git clone https://github.com/marshmallow-code/flask-marshmallow.git
$ cd flask-marshmallow
2. Install development requirements. **It is highly recommended that you use a virtualenv.**
Use the following command to install an editable version of
flask-marshmallow along with its development requirements.
::
# After activating your virtualenv
$ pip install -e '.[dev]'
3. (Optional, but recommended) Install the pre-commit hooks, which will format and lint your git staged files.
::
# The pre-commit CLI was installed above
$ pre-commit install
.. note::
flask-marshmallow uses `black <https://github.com/ambv/black>`_ for code formatting, which is only compatible with Python>=3.6. Therefore, the ``pre-commit install`` command will only work if you have the ``python3.6`` interpreter installed.
Git Branch Structure
********************
flask-marshmallow abides by the following branching model:
``dev``
Current development branch. **New features should branch off here**.
``X.Y-line``
Maintenance branch for release ``X.Y``. **Bug fixes should be sent to the most recent release branch.**. The maintainer will forward-port the fix to ``dev``. Note: exceptions may be made for bug fixes that introduce large code changes.
**Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes.
Pull Requests
**************
1. Create a new local branch.
::
# For a new feature
$ git checkout -b name-of-feature dev
# For a bugfix
$ git checkout -b fix-something 1.2-line
2. Commit your changes. Write `good commit messages <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
::
$ git commit -m "Detailed commit message"
$ git push origin name-of-feature
3. Before submitting a pull request, check the following:
- If the pull request adds functionality, it is tested and the docs are updated.
- You've added yourself to ``AUTHORS.rst``.
4. Submit a pull request to ``marshmallow-code:dev`` or the appropriate maintenance branch. The `Travis CI <https://travis-ci.org/marshmallow-code/flask-marshmallow>`_ build must be passing before your pull request is merged.
Running Tests
*************
To run all tests: ::
$ pytest
To run syntax checks: ::
$ tox -e lint
(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::
$ tox
Documentation
*************
Contributions to the documentation are welcome. Documentation is written in `reStructuredText`_ (rST). A quick rST reference can be found `here <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
To build the docs in "watch" mode: ::
$ tox -e watch-docs
Changes in the `docs/` directory will automatically trigger a rebuild.
Contributing Examples
*********************
Have a usage example you'd like to share? Feel free to add it to the `examples <https://github.com/marshmallow-code/flask-marshmallow/tree/dev/examples>`_ directory and send a pull request.
.. _Sphinx: http://sphinx.pocoo.org/
.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html
.. _flask-marshmallow: https://github.com/marshmallow-code/flask-marshmallow
|
