archive-gh-me/marko
1
0
Fork 0
mirror of https://github.com/marko-js/marko.git synced 2025-12-08 19:26:05 +00:00
Code Issues Projects Releases Wiki Activity

Updated CONTRIBUTING.md with CLA text

Browse Source
This commit is contained in:
Patrick Steele-Idem 2016-11-02 16:31:46 -06:00
parent 614d3ac34a
commit 78c7dceebd
1 changed files with 15 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
.github/CONTRIBUTING.md vendored
View File

@ -2,7 +2,7 @@
:+1::tada: We're excited you want to contribute! Read on! :tada::+1:
[Pull requests](#pull-requests-are-always-welcome) •
[Pull requests](#pull-requests-are-always-welcome) •
[Tackling issues](#tackling-an-existing-issue) •
[Reporting bugs](#reporting-bugs-and-other-issues) •
[Maintainers](#maintainers) •
@ -10,18 +10,13 @@
## Pull requests are always welcome
Not sure if that typo is worth a pull request? Found a bug and know how to fix
it? Do it! We will appreciate it. Any significant improvement should be
documented as [a GitHub issue](https://github.com/marko-js/marko/issues) before
anybody starts working on it.
Not sure if that typo is worth a pull request? Found a bug and know how to fix it? Do it! We will appreciate it. Any significant improvement should be documented as [a GitHub issue](https://github.com/marko-js/marko/issues) before anybody starts working on it.
We are always thrilled to receive pull requests. We do our best to process them
quickly. If your pull request is not accepted on the first try,
don't get discouraged! We'll work with you to come to an acceptable solution.
We are always thrilled to receive pull requests. We do our best to process them quickly. If your pull request is not accepted on the first try, don't get discouraged! We'll work with you to come to an acceptable solution.
If you're new to GitHub or open source you can check out this
[free course](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
on how to contribute to an open source project.
If you're new to GitHub or open source you can check out this [free course](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) on how to contribute to an open source project.
_Disclaimer: Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please state that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so._
### Running tests
@ -53,12 +48,9 @@ In most cases you'll simply copy a directory and modify it to add a new test. A
## Tackling an existing issue
Comment on the issue and let us know you'd like to tackle it.
We'll assign you to the issue so that we don't duplicate effort.
Comment on the issue and let us know you'd like to tackle it. We'll assign you to the issue so that we don't duplicate effort.
If for some reason you aren't going to be able to complete the work,
let us know as soon as you can so we can open it up for another
developer to work on.
If for some reason you aren't going to be able to complete the work, let us know as soon as you can so we can open it up for another developer to work on.
Here's some to get started with:
@ -68,30 +60,19 @@ Here's some to get started with:
## Reporting bugs and other issues
A great way to contribute to the project is to send a detailed report when you
encounter an issue.
A great way to contribute to the project is to send a detailed report when you encounter an issue.
Check that [our issue database](https://github.com/marko-js/marko/issues)
doesn't already include that problem or suggestion before submitting an issue.
If you find a match, you can use the "subscribe" button to get notified on
updates. Rather than leaving a "+1" or "I have this too" comment, you can add a
[reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
to let us know that this is also affecting you without cluttering the conversation.
However, if you have ways to reproduce the issue or have additional information that may help
resolving the issue, please leave a comment.
Check that [our issue database](https://github.com/marko-js/marko/issues) doesn't already include that problem or suggestion before submitting an issue. If you find a match, you can use the "subscribe" button to get notified on updates. Rather than leaving a "+1" or "I have this too" comment, you can add a [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) to let us know that this is also affecting you without cluttering the conversation. However, if you have ways to reproduce the issue or have additional information that may help resolving the issue, please leave a comment.
We have an [ISSUE_TEMPLATE](ISSUE_TEMPLATE.md) that will populate your textarea
when you go to open an issue. Use the relevant section and remove the rest.
We have an [ISSUE_TEMPLATE](ISSUE_TEMPLATE.md) that will populate your textarea when you go to open an issue. Use the relevant section and remove the rest.
Please provide as much detail as possible.
### Reporting security issues
If you discover a security issue, please **DO NOT** file a public issue,
instead send your report [privately](https://gitter.im/patrick-steele-idem).
If you discover a security issue, please **DO NOT** file a public issue, instead send your report [privately](https://gitter.im/patrick-steele-idem).
Security reports are greatly appreciated and we will publicly thank you for it.
We currently do not offer a paid security bounty program.
Security reports are greatly appreciated and we will publicly thank you for it. We currently do not offer a paid security bounty program.
# Maintainers
@ -102,9 +83,7 @@ We currently do not offer a paid security bounty program.
# Labels
Once you post an issue, a maintainer will add one or more labels to it.
Below is a guideline for the maintainers and anyone else who is interested
in what the various labels mean.
Once you post an issue, a maintainer will add one or more labels to it. Below is a guideline for the maintainers and anyone else who is interested in what the various labels mean.
### Type
![](https://img.shields.io/badge/type-bug-dd0000.svg)
@ -114,7 +93,7 @@ in what the various labels mean.
Every issue should be assigned one of these.
- **bug**: A bug report
- **bug**: A bug report
- **enhancement**: A feature request
- **question**: A question about how to use Marko
- **docs**: An issue about documentation