Skip to content

Commit b8ef370

Browse files
committed
issue-624 updates CONTRIBUTING LICENSE and README. Adds Akamai.
1 parent 75d485a commit b8ef370

File tree

3 files changed

+46
-7
lines changed

3 files changed

+46
-7
lines changed

CONTRIBUTING.rst

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
Contributing
22
============
33

4-
flask-restplus is open-source and very open to contributions.
4+
flask-restplus is open-source and very open to contributions.
5+
6+
If you're part of a corporation with an NDA, and you may require updating the license.
7+
See Updating Copyright below
58

69
Submitting issues
710
-----------------
@@ -24,11 +27,15 @@ Submitting patches (bugfix, features, ...)
2427
If you want to contribute some code:
2528

2629
1. fork the `official flask-restplus repository`_
27-
2. create a branch with an explicit name (like ``my-new-feature`` or ``issue-XX``)
28-
3. do your work in it
29-
4. rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase)
30-
5. add you change to the changelog
31-
6. submit your pull-request
30+
2. Ensure an issue is opened for your feature or bug
31+
3. create a branch with an explicit name (like ``my-new-feature`` or ``issue-XX``)
32+
4. do your work in it
33+
5. Commit your changes. Ensure the commit message includes the issue. Also, if contributing from a corporation, be sure to add a comment with the Copyright information
34+
6. rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase)
35+
7. add you change to the changelog
36+
8. submit your pull-request
37+
9. 2 Maintainers should review the code for bugfix and features. 1 maintainer for minor changes (such as docs)
38+
10. After review, a maintainer a will merge the PR. Maintainers should not merge their own PRs
3239

3340
There are some rules to follow:
3441

@@ -51,7 +58,7 @@ An Invoke ``tasks.py`` is provided to simplify the common tasks:
5158
Available tasks:
5259
5360
all Run tests, reports and packaging
54-
assets Fetch web assets
61+
assets Fetch web assets -- Swagger. Requires NPM (see below)
5562
clean Cleanup all build artifacts
5663
cover Run tests suite with coverage
5764
demo Run the demo
@@ -86,3 +93,28 @@ and the documentation is properly generating.
8693

8794
.. _official flask-restplus repository: https://github.com/noirbizarre/flask-restplus
8895
.. _official bugtracker: https://github.com/noirbizarre/flask-restplus/issues
96+
97+
Running a local Swagger Server
98+
------------------------------
99+
100+
For local development, you may wish to run a local server. running the following will install a swagger server
101+
102+
.. code-block:: console
103+
104+
$ inv assets
105+
106+
NOTE: You'll need `NPM <https://docs.npmjs.com/getting-started/>`_ installed to do this.
107+
If you're new to NPM, also check out `nvm <https://github.com/creationix/nvm/blob/master/README.md>`_
108+
109+
110+
Updating Copyright
111+
------------------
112+
113+
If you're a part of a corporation with an NDA, you may be required to update the LICENSE.
114+
115+
1. Check with your legal department first.
116+
2. Add an appropriate line to the LICENSE file. See the Akamai entry for an example
117+
3. When making a commit, add the specific copyright notice.
118+
119+
Double check with your legal department about their regulations. Not all changes
120+
constitute new or unique work.

LICENSE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ BSD 3-Clause License
22

33
Original work Copyright (c) 2013 Twilio, Inc
44
Modified work Copyright (c) 2014 Axel Haustant
5+
Addition contributions Copyright (c) 2019 Akamai Technologies
6+
57
All rights reserved.
68

79
Redistribution and use in source and binary forms, with or without

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,8 @@ The documentation is hosted `on Read the Docs <http://flask-restplus.readthedocs
162162

163163
.. _Flask: http://flask.pocoo.org/
164164
.. _Swagger: http://swagger.io/
165+
166+
167+
Contribution
168+
============
169+
Want to contribute! That's awesome! Check out `CONTRIBUTING.rst! <https://github.com/noirbizarre/flask-restplus/blob/master/CONTRIBUTING.rst>`_

0 commit comments

Comments
 (0)