Improve README and GitHub templates

This commit is contained in:
Jürg Lehni 2018-02-03 22:39:07 +01:00
parent ec1e3262b6
commit 3f73d55c3f
3 changed files with 31 additions and 24 deletions

View file

@ -1,20 +1,21 @@
<!-- <!--
Questions: This issues database is used to keep track of bugs and new features.
https://groups.google.com/group/paperjs For questions and support, please visit the Gitter channel instead:
https://gitter.im/paperjs/paper.js https://gitter.im/Vincit/objection.js
--> -->
# Description/Steps to reproduce # Description/Steps to reproduce
<!-- <!--
If feature: A description of the feature If a feature: A description of the feature.
If bug: Steps to reproduce If a bug: The steps to reproduce the issue.
--> -->
# Link to reproduction test-case # Link to reproduction test-case
<!-- <!--
Link to a test-case for reproduction Please link to a test-case for reproduction, ideally as a repository with a
`packages.json` that installs all required dependencies to reduce confusion.
Note: Failure to provide a test-case for reproduction purposes will result in Note: Failure to provide a test-case for reproduction purposes will result in
the issue being closed. the issue being closed.
@ -23,16 +24,16 @@ the issue being closed.
# Expected result # Expected result
<!-- <!--
Also include actual results if bug Also include actual results when reporting a bug.
--> -->
# Additional information # Additional information
<!-- <!--
Please include the versions of Operating System and Browser that the issue is Please include the type and versions of Operating System, Node, as well as
encountered on. the underlying database that the issue is encountered on.
Examples: Examples:
macOS 10.12.6, Chrome 60.0.3112.113 macOS 10.12.6, Node 8.9.0, PostgreSQL 10.0
Windows 10 Pro 10586.962, Edge 25.10586.672.0 Windows 10 Pro 10586.962, Node 8.8.1, SQLite 3
--> -->

View file

@ -4,21 +4,24 @@
#### Related issues #### Related issues
<!-- <!--
Please use the following link syntaxes: Please list related issues and discussion by using the following syntax:
- relates to #49 (to reference issues in the current repository) - Relates to #49
(to reference issues in the Objection.js repository)
- Relates to https://github.com/tgriesser/knex/issues/100
(to reference issues in a related repository)
--> -->
- relates to <link_to_referenced_issue> - Relates to <link_to_referenced_issue>
### Checklist ### Checklist
<!-- <!--
- Please mark your choice with an "x" (i.e. [x], see - Please mark your choice with an "x" (i.e. [x], see
https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments) https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
- PR's without test coverage will be closed. - PR's without test coverage will be closed.
--> -->
- [ ] New tests added or existing tests modified to cover all changes - [ ] New tests added or existing tests modified to cover all changes
- [ ] Code conforms with the [style - [ ] Code conforms with the ESLint and Prettier rules (`yarn eslint` passes
guide](https://github.com/paperjs/paper.js/blob/develop/RULES.md) and `yarn prettier` has been applied)

View file

@ -8,8 +8,10 @@ from [http://paperjs.org/download/](http://paperjs.org/download/)
- Mainline source code: <https://github.com/paperjs/paper.js> - Mainline source code: <https://github.com/paperjs/paper.js>
- Twitter: [@paperjs](http://twitter.com/paperjs) - Twitter: [@paperjs](http://twitter.com/paperjs)
- Latest releases: <http://paperjs.org/download/> - Latest releases: <http://paperjs.org/download/>
- Pre-built development versions: [`prebuilt/module`](https://github.com/paperjs/paper.js/tree/prebuilt/module) - Pre-built development versions:
and [`prebuilt/dist`](https://github.com/paperjs/paper.js/tree/prebuilt/dist) branches. [`prebuilt/module`](https://github.com/paperjs/paper.js/tree/prebuilt/module)
and [`prebuilt/dist`](https://github.com/paperjs/paper.js/tree/prebuilt/dist)
branches.
## Installing Paper.js ## Installing Paper.js
@ -280,10 +282,10 @@ The main Paper.js source tree is hosted on GitHub, thus you should create a fork
of the repository in which you perform development. See of the repository in which you perform development. See
<http://help.github.com/forking/>. <http://help.github.com/forking/>.
We prefer that you send a [pull request on GitHub](http://help.github.com/pull-requests/) We prefer that you send a
which will then be merged into the [pull request on GitHub](http://help.github.com/pull-requests/)
official main line repository. You need to sign the Paper.js CLA to be able to which will then be merged into the official main line repository.
contribute (see below). You need to sign the Paper.js CLA to be able to contribute (see below).
Also, in your first contribution, add yourself to the end of `AUTHORS.md` (which Also, in your first contribution, add yourself to the end of `AUTHORS.md` (which
of course is optional). of course is optional).
@ -358,4 +360,5 @@ For a list of authors and contributors, please see
## License ## License
Distributed under the MIT license. See Distributed under the MIT license. See
[LICENSE](https://github.com/paperjs/paper.js/blob/master/LICENSE.txt) for details. [LICENSE](https://github.com/paperjs/paper.js/blob/master/LICENSE.txt)
fo details.