From 8ab560f07b112f3c425c7bfb8ac01b5606ae9222 Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Mon, 8 Oct 2018 15:04:22 +0100 Subject: [PATCH] Update github files --- .github/.github/CODE_OF_CONDUCT | 47 ++++++ .github/.github/CONTRIBUTING.md | 69 ++++++++ .github/.github/ISSUE_TEMPLATE.md | 17 ++ .github/.github/LICENSE.txt | 202 +++++++++++++++++++++++ .github/.github/PULL_REQUEST_TEMPLATE.md | 35 ++++ 5 files changed, 370 insertions(+) create mode 100644 .github/.github/CODE_OF_CONDUCT create mode 100644 .github/.github/CONTRIBUTING.md create mode 100644 .github/.github/ISSUE_TEMPLATE.md create mode 100644 .github/.github/LICENSE.txt create mode 100644 .github/.github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/.github/CODE_OF_CONDUCT b/.github/.github/CODE_OF_CONDUCT new file mode 100644 index 0000000..549bd9f --- /dev/null +++ b/.github/.github/CODE_OF_CONDUCT @@ -0,0 +1,47 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at #aerogear channel on freenode IRC or via aerogear@googlegroups.com, see [AeroGear forum](https://groups.google.com/forum/#!forum/aerogear). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +For more information about the AeroGear community and project , visit [our website](https://aerogear.org/community/). + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/.github/CONTRIBUTING.md b/.github/.github/CONTRIBUTING.md new file mode 100644 index 0000000..85732c9 --- /dev/null +++ b/.github/.github/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# How to contribute + +Thank you for your interest in contributing to the AeroGear project. We want +keep this process as easy as possible so we've outlined a few guidelines below. +For more information about the AeroGear community and project , visit +[our website](https://aerogear.org/community/). + +## Asking for help + +Whether you're contributing a new feature or bug fix, or simply submitting a ticket, the AeroGear team is available for technical advice or feedback. +You can reach us at #aerogear on [Freenode IRC](https://freenode.net/) or join the [mailing list](https://groups.google.com/forum/#!forum/aerogear) +-- both are actively monitored. + +## Getting started + +* Make sure you have a [JIRA account](https://issues.jboss.org) +* Make sure you have a [GitHub account](https://github.com/signup/free) +* Submit a ticket for your issue to the +[AeroGear project]("https://issues.jboss.org/projects/AEROGEAR), assuming one does +not already exist. + * Clearly describe the issue including steps to reproduce when it is a bug. + * Make sure you fill in the earliest version that you know has the issue. +* Fork the repository on GitHub. + +## Making changes + +* Create a topic branch from where you want to base your work. + * This is usually the master branch. + * To quickly create a topic branch based on master; `git checkout -b + master`. By convention we typically include the JIRA issue + key in the branch name, e.g. `AEROGEAR-1234-my-feature`. + * Please avoid working directly on the `master` branch. +* Make commits of logical units. +* Prepend your commit messages with a JIRA ticket number, e.g. "AEROGEAR-1234: Fix + spelling mistake in README." +* Follow the coding style in use. +* Check for unnecessary whitespace with `git diff --check` before committing. +* Make sure you have added the necessary tests for your changes. +* Run _all_ the tests to assure nothing else was accidentally broken. + +## Submitting changes + +* Push your changes to a topic branch in your fork of the repository. +* Submit a pull request to the repository in the [AeroGear GitHub organization] + (https://github.com/aerogear) and choose branch you want to patch + (usually master). + * Advanced users may want to install the [GitHub CLI](https://hub.github.com/) + and use the `hub pull-request` command. +* Update your JIRA ticket to mark that you have submitted code and are ready +for it to be reviewed (Status: Dev Complete). + * Include a link to the pull request in the ticket. +* Add detail about the change to the pull request including screenshots + if the change affects the UI. + +## Reviewing changes + +* After submitting a pull request, one of AeroGear team members will review it. +* Changes may be requested to conform to our style guide and internal + requirements. +* When the changes are approved and all tests are passing, a AeroGear team + member will merge them. +* Note: if you have write access to the repository, do not directly merge pull + requests. Let another team member review your pull request and approve it. + +# Additional Resources + +* [General GitHub documentation](http://help.github.com/) +* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) +* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details diff --git a/.github/.github/ISSUE_TEMPLATE.md b/.github/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..14ac8a1 --- /dev/null +++ b/.github/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +## Description +Add a brief and meaningful description. + +## Expected Behavior +Describe the expected behaviour. + +## Actual Behavior +Describe the current/actual behaviour. + +## Environment + +* Operating system: +* OpenShift versions: +* Project Versions: + +## Steps to reproduce +Describe all steps and pre-requirements which are required to be performed in order to reproduce this scenario. ( E.g 1. Action, 2. Action ... ) diff --git a/.github/.github/LICENSE.txt b/.github/.github/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/.github/.github/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/.github/.github/PULL_REQUEST_TEMPLATE.md b/.github/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a12d63c --- /dev/null +++ b/.github/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +## Motivation +Add references to relevant tickets or a short description about what motivated you do it. (E.g JIRA: https://issues.jboss.org/browse/AEROGEAR-{} AND/OR ISSUE: https://github.com/aerogear/standards/issues/{}) + +## What +Add an short answer for: What was done in this PR? (E.g Don't allow users has access to the feature X.) + +## Why +Add an short answer for: Why it was done? (E.g The feature X was deprecated.) + +## How +Add an short answer for: How it was done? (E.g By removing this feature from ... OR By removing just the button but not its implementation ... ) + +## Verification Steps +Add the steps required to check this change. Following an example. + +1. Go to `XX >> YY >> SS` +2. Create a new item `N` with the info `X` +3. Try to edit this item +4. Check if in the left menu the feature X is not so long present. + +## Checklist: + +- [ ] Code has been tested locally by PR requester +- [ ] Changes have been successfully verified by another team member + +## Progress + +- [x] Finished task +- [ ] TODO + +## Additional Notes + +PS.: Add images and/or .gifs to illustrate what was changed if this pull request modifies the appearance/output of something presented to the users. + +