Skip to content

Commit 7b2fd63

Browse files
authored
Merge pull request jdf#134 from jeremydouglass/jeremydouglass-patch-add-license-1
Add LICENSE, move CONTRIBUTING.md
2 parents 1bbe055 + 0f3360a commit 7b2fd63

3 files changed

Lines changed: 58 additions & 12 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Contributing
2+
3+
Thank you for your interest in contributing to the Python Mode for Processing
4+
reference documentation and website. We welcome contributions!
5+
6+
To contribute new documentation or fixes to the
7+
existing documentation, create a fork of the
8+
[processing-py-site](https://github.com/kazimuth/processing-py-site) repository
9+
on GitHub. With `git`, create a new branch in your fork and make your changes,
10+
ensuring that `python generator.py build --all --images` completes without
11+
errors. When you're done, push your branch to your fork of the project on
12+
Github, and then issue a Pull Request against the main repository. [Here's a
13+
good overview of the pull request
14+
process](https://yangsu.github.io/pull-request-tutorial/) on GitHub. (If you're
15+
totally unfamiliar with Git or GitHub, [try this
16+
tutorial](https://try.github.io/).
17+
18+
Pull requests will be automatically tested Travis-CI, and will receive a pass
19+
or fail mark. If the build fails, please review the log for why. Common reasons
20+
may include metadata categort checks by generator.py, or generate_images.py not
21+
generating an image. For troubleshooting, see [README.md](README.md).
22+
23+
All contributions are distributed under the current license, see:
24+
[LICENSE](LICENSE).
25+
26+
This license is for the website documentation of Python Mode for Processing.
27+
The Python Mode for Processing software is licensed seperately, currently under
28+
Apache 2.0.

‎LICENSE‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Jonathan Feinberg, Miles Peyton, James Giles, Allison Parrish
4+
and contributors
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

‎README.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,18 +137,14 @@ operating system. Then run the build script like so:
137137

138138
xvfb-run python generator.py build --images
139139

140-
## Contributing
140+
## Reporting Issues
141141

142-
We welcome contributions! To contribute new documentation or fixes to the
143-
existing documentation, create a fork of the
144-
[processing-py-site](https://github.com/kazimuth/processing-py-site) repository
145-
on GitHub. With `git`, create a new branch in your fork and make your changes,
146-
ensuring that `python generator.py build --all --images` completes without
147-
errors. When you're done, push your branch to your fork of the project on
148-
Github, and then issue a Pull Request against the main repository. [Here's a
149-
good overview of the pull request
150-
process](https://yangsu.github.io/pull-request-tutorial/) on GitHub. (If you're
151-
totally unfamiliar with Git or GitHub, [try this
152-
tutorial](https://try.github.io/).
142+
Before opening a new issue, please review existing [issues](issues).
153143

144+
Issues should include as many details as possible, including URLs and/or
145+
excerpts from the related material, and a description of what is missing/wrong
146+
or could be improved, and if possible how.
154147

148+
## Contributing:
149+
150+
see [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)