diff --git a/KOSU_ISSUE_TEMPLATE.md b/KOSU_ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e68b6ecb --- /dev/null +++ b/KOSU_ISSUE_TEMPLATE.md @@ -0,0 +1,45 @@ +_Base issue template for Kosu projects. Modify as needed._ + +# Overview + +_Summarize the issue. Why are you here?_ + +# Description + +_Provide additional details about the bug/issue. Include the two sections below for bugs._ + +## Expected behavior + +_What should happen?_ + +## Current behavior + +_What is happening?_ + +## Steps to reproduce + +_In as much detail as possible, describe how to re-create the bug._ + +``` +1. +2. +3. +... +``` + +## Environment + +_Describe environment, incl. package name/version, OS version, runtime, etc._ + +# Notes + +_Space for additional comments, ideas about how to fix, what the cause is, etc._ + +# Action items + +_If there are any, include action items here in check boxes. Example shown below._ + +- [ ] Verify this is incorrect behavior +- [ ] Isolate and determine cause +- [ ] Assign team member to fix +- [ ] Move discussion to PR \ No newline at end of file diff --git a/KOSU_PR_TEMPLATE.md b/KOSU_PR_TEMPLATE.md new file mode 100644 index 00000000..e5bb2d38 --- /dev/null +++ b/KOSU_PR_TEMPLATE.md @@ -0,0 +1,43 @@ +_Pull request template for Kosu projects. Modify minimally as needed on a project basis._ + +# Overview + +_Provide a brief summary of the PR and it's purpose. May include plans if a [WIP]._ + +# Description + +_Describe in detail what changes you plan to make in this section and sub-sections_ + +## Relevant links + +_Link any supporting material to help people understand your PR. This may inclue links to discussions that took place in an issue or other forum, or links to the problematic code you plan to change._ + +_This section may be omitted as necessary._ + +## Testing instructions + +_Provide directors for reviewers and others to test your changes. What should happen when your changes are finalized?_ + +## Types of changes + +_Check one of the boxes below, and add additional information as necessary._ + +- [ ] Bug fix (non-breaking change which fixes an issue) + +- [ ] New feature (non-breaking change which adds functionality, compatible with previous versions) + +- [ ] Breaking change (feature or bug-fix that changes behavior and requires a major/minor version bump) + +# Notes + +_Include any additional comments, thoughts, questions, or discussion items here that don't fit elsewhere. Omit as needed._ + +# Status + +_Use this section to keep reviews and maintainers up-to-date with the status and progress of your PR. Check any boxes that are already complete upon creation of the PR, and update whenever necessary. Don't hesitate to ask for help._ + +- [ ] Prefix PR title with `[WIP]` if necessary (changes not yet made). +- [ ] Add tests to cover changes as needed. +- [ ] Update documentation as needed. +- [ ] Add new entries to the relevant CHANGELOG file(s). +- [ ] Ready for review \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..670154e3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,116 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; + + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; + + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and + + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time +extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. + + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. + + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. + +For more information, please see +