Skip to content
This repository has been archived by the owner on Jan 4, 2020. It is now read-only.

Commit

Permalink
Added contributing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RedKenrok committed Nov 16, 2018
1 parent 8b428ae commit 2f08a8b
Show file tree
Hide file tree
Showing 8 changed files with 125 additions and 1 deletion.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/ask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Ask
about: Ask a question. Whether something is unclear or missing we would love to help.
labels:
- question
---

**Description**: *Write a concise description of what problem you encountered.*



**Attempts**: *Check off each box by placing a `x` inside the brackets after making sure you agree to the term outlined.*

* [ ] I have read the relevant documentation.
* [ ] I have searched through open and closed issues.

**Other attempts**: *List what else you have already done to resolve this question.*

* I have ...

**Write any additional context in place of this.**
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Report
about: Report a problem. Perhaps you discovered a bug and we can help fix the problem.
labels:
- bug
---

**Description**: *Write a concise description of what problem you encountered.*



**Actions**: *List actions you took so we can reproduce the issue.*
1.
2.
3.

**Expectation**: *Write the result you expected to have.*



**Environment**: *List your build environment and their versions.*
* OS: [e.g. `Windows 10`]
* Node version: [e.g. `8.12.0`]
* Program version: [e.g. `1.1.0`]

**Write any additional context in place of this.**
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/suggest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Suggest
about: Suggest an idea. Help us improve and grow the project with your suggestions.
labels:
- enhancement
---

**Category**: `Feature` / `Fix` / `Improvement` / `Other` *Remove any non-applicable categories.*

**Problem description**: *Write a concise description of what problem this would solve.*



**Solution description**: *Write a concise description of what you would like to see changed.*



**Alternative solutions**: *Optionally write concise descriptions of other solution you have considered.*



**Write any additional context in place of this.**
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
**Category**: `Code fix` / `Documentation fix` / `Improvement` / `New feature` / `Other` *Remove any non-applicable categories.*

**Issue**: *Reference the issue(s).*

**Changes**: *Write a concise description of what the pull request changes.*



**Drawbacks**: *If applicable write a concise description of what draw backs the changes could have.*



**Write any additional context in place of this.**

**Checklist**: *Check off the box by placing a `x` inside the brackets after making sure you agree to the term outlined.*
* [ ] I have read and followed the [Contributing guide](https://github.com/hoast/contribute/blob/master/CONTRIBUTING.md).
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> See the organization's [code of conduct page](https://hoast.js.org/code-of-conduct).
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> See the organization's [contributing page](https://hoast.js.org/contributing), if you just want to report an issue skip to the [issues section](https://hoast.js.org/contributing#issues).
37 changes: 37 additions & 0 deletions DCO
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ISC License

Copyright (c) 2018 Ron Dekker <https://rondekker.nl>
Copyright (c) 2018 Ron Dekker <[email protected]>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down

0 comments on commit 2f08a8b

Please sign in to comment.