From 72c55e967d7c09bac6cc3c60fb35927763146961 Mon Sep 17 00:00:00 2001 From: Marcus Stade Date: Tue, 9 Aug 2016 19:10:19 +0200 Subject: [PATCH] Put project in line with zambezi/project --- .github/ISSUE_TEMPLATE.md | 22 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 ++++++++++++++ AUTHORS.md | 14 ++++++++ CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++++++ LICENSE.md | 7 ++++ man/rationale.md => RATIONALE.md | 0 README.md | 14 +++++++- SUMMARY.md | 9 ++++- 8 files changed, 145 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 AUTHORS.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md rename man/rationale.md => RATIONALE.md (100%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..5de85f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,22 @@ + + +## Expected Behavior + + +## Current Behavior + + +## Steps to Reproduce (for bugs) + +1. +2. +3. + +## Context + + +## Environment + +* Version used: +* Environment name and version (e.g. Chrome 39, node.js 5.4): +* Operating System and version (desktop or mobile): \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7824c08 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ + + +## Description + + +## Motivation and Context + + +## How Was This Tested? + + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + +- [ ] My change follows the style of this project +- [ ] My change requires a change to the documentation +- [ ] I have updated the documentation accordingly +- [ ] I have read the [contribution guidelines](../CONTRIBUTING.md) +- [ ] I have added tests to cover my changes +- [ ] All new and existing tests passed diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..1c8c586 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,14 @@ +Thank You! +========== + +This project exists thanks to the tireless efforts of all who have contributed – directly, or indirectly – in one way or another. For your time, effort, and expertise – thank you! + +The following shell script will print a list of all contributors to this repository's history: + +```bash +git log --pretty="%aN" | sort | uniq +``` + +--- + +[Full list of contributors](../../contributors). \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e918ca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +Contributing to This Project +============================ + +You're very welcome to contribute to this project! By making your contributions available, you implicitly agree to the contribution terms set forth in this document. If you do *not* approve of these terms, you must *not* make contributions to this project. + +Issues +------ + +Issues and enhancement requests are very welcome, as well as general discussion. Simply [create a new issue](../../issues/new) to get the discussion started! + +Contributing +------------ + +This project follow the "fork-and-pull" model of open source development: + +1. **Fork** the repo on GitHub +2. **Clone** the project to your own machine +3. **Commit** changes to your own branch +4. **Push** your work back up to your fork +5. Submit a **Pull request** so that we can review your changes + +**NOTE**: Be sure to merge the latest upstream changes before making a pull request! + +Copyright & Licensing +--------------------- + +Please see the [license](LICENSE.md) for detailed licensing and copyright information. + +We do not require you to assign the copyright of your contributions, and you retain the copyright. However, in order to be included in this, and potentially other projects, your contributions *must* also be made available under the same [license](LICENSE.md). + +If you do *not* agree with these terms, you must *not* make your contributions available. Unless *explicitly* stated otherwise, you agree to these terms simply by making your contributions available. + +### FAQ + +**Q:** I'm contributing on behalf of my employer, is this ok? +**A:** So long as you have the legal authority to make contributions and your employer agrees with the terms, we will happily accept contributions! + +**Q:** Can I contribute code or other material created by others? +**A:** Maybe, but please *do not assume you can*. Any contributions you make must be made available under the [same license as the project](LICENSE.md) and you *must* make sure you have the legal authority to make this contribution. If in doubt, please refrain from contributing or contact the original author to get their explicit approval. + +**Q:** Can I contribute code or other material under a different license? +**A:** No. Any contributions *must* be made available under the [same license as the project](LICENSE.md). + +**Q:** What does your license even mean? +**A:** The license sets out the terms under which you may use or reference this project. If you're in any doubt about it you should definitely consider seeking legal advice from a lawyer or other legal representative. + +Code of Conduct +--------------- + +With any contribution to this, or other open source projects, please make every effort to make this a nice experience for everyone. + +Please **be open** with your contributions, by not using private communications whenever possible. Also **be concise**, and whenever long form discussions are required, add a summary where appropriate. + +Additionally, it's important to **assume good faith** when working together. Your way of working may be different from that of others, so try your best to **be collaborative** and assume you are working toward the same goals. + +As collaborators may be from any part of the world and of any cultural heritage, we ask that you **be inclusive** and most importantly **be respectful!** Harassment or abuse of any kind will *not* be tolerated. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..1098285 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright (c) 2016 The project contributors – see [AUTHORS](AUTHORS.md). + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/man/rationale.md b/RATIONALE.md similarity index 100% rename from man/rationale.md rename to RATIONALE.md diff --git a/README.md b/README.md index b09123f..387a72a 100644 --- a/README.md +++ b/README.md @@ -154,4 +154,16 @@ With the advent of technologies such as React, it is not uncommon to want to ext $ ez-build --include "js:**/*.js,js:**/*.jsx" ``` - Note that we add the `js:**/*.js` pattern in addition to `js:**/*.jsx`, since using this option overwrites the defaults. Also note the use of namespaces in the patterns, to determine which pipeline the pattern should affect. \ No newline at end of file + Note that we add the `js:**/*.js` pattern in addition to `js:**/*.jsx`, since using this option overwrites the defaults. Also note the use of namespaces in the patterns, to determine which pipeline the pattern should affect. + +Found an issue, or want to contribute? +-------------------------------------- + +If you find an issue, want to start a discussion on something related to this project, or have suggestions on how to improve it? Please [create an issue](../../issues/new)! + +See an error and want to fix it? Want to add a file or otherwise make some changes? All contributions are welcome! Please refer to the [contribution guidelines](CONTRIBUTING.md) for more information. + +License +------- + +Please refer to the [license](LICENSE.md) for more information on licensing and copyright information. \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index f510b6a..b13eee8 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1 +1,8 @@ -- [Rationale](man/rationale.md) \ No newline at end of file +- [Introduction](README.md) +- [Rationale](RATIONALE.md) +- [How to contribute](CONTRIBUTING.md) + +--- + +- [Authors](AUTHORS.md) +- [License](LICENSE.md) \ No newline at end of file