diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 54e170f5cd4..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ - - -## Expected Behavior -{...} - -## Current Behavior -{...} - -## Steps to reproduce the issue -1. {...} -2. {...} -3. {...} - -## Context -- UI5 Module Version *(output of `ui5 --version` when using the CLI)*: `{...}` -- Node.js Version: `{...}` -- npm Version: `{...}` -- OS/Platform: `{...}` -- Browser *(if relevant)*: `{...}` -- Other information: `{...}` - -## Affected components *(if known)* - -- [ ] [ui5-builder](https://github.com/SAP/ui5-builder) -- [ ] [ui5-server](https://github.com/SAP/ui5-server) -- [ ] [ui5-cli](https://github.com/SAP/ui5-cli) -- [ ] [ui5-fs](https://github.com/SAP/ui5-fs) -- [ ] [ui5-project](https://github.com/SAP/ui5-project) -- [ ] [ui5-logger](https://github.com/SAP/ui5-logger) - -## Log Output / Stack Trace -``` -{...} -``` diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000000..c799b1987b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,49 @@ +--- +name: Bug Report +about: Report an issue with UI5 Tooling +title: '' +labels: bug, needs triage +assignees: '' + +--- + + + +## Expected Behavior +{...} + +## Current Behavior +{...} + +## Steps to Reproduce the Issue + +1. {...} +2. {...} +3. {...} + +## Context + * UI5 Module Version (output of `ui5 --version` when using the CLI): **`unknown`** + * Node.js Version: **`unknown`** + * npm Version: `unknown` + * OS/Platform: `unknown` + * Browser *(if relevant)*: `unknown` + * Other information regarding your environment *(optional)*: `nothing` + +## Log Output / Stack Trace + + +``` +{...} +``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..0086358db1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000000..070221335fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,25 @@ +--- +name: Feature Request +about: Request a new feature to be added to UI5 Tooling +title: '' +labels: enhancement +assignees: '' + +--- + + + +## Is your feature request related to a problem? Please describe. +A clear and concise description of the problem, e.g. "I'm always frustrated when {...}" + +## Describe the solution you'd like +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context +Add any other context or screenshots about the feature request here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..5303a0c93ed --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward each other +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from our experiences +* Focusing on what is best not just for us as individuals, but for the + entire community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +openui5@sap.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5b8b03a94e..11c11bd91bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,58 +1,29 @@ # Contributing to the UI5 Tooling -## ๐Ÿ“– Content - 1. [Analyzing Issues](#-analyzing-issues) - 2. [Reporting Issues](#-reporting-issues) - 3. [Contributing Code](#-contributing-code) - -## โšก๏ธ Quick Links -- [UI5 Tooling - Task Board](https://github.com/orgs/SAP/projects/1) - +
- Card filter for project maintainers -

- - ``` - is:open repo:SAP/ui5-tooling repo:SAP/ui5-cli repo:SAP/ui5-logger repo:SAP/ui5-project repo:SAP/ui5-server repo:SAP/ui5-builder repo:SAP/ui5-fs sort:updated-desc -label:enhancement -label:documentation -label:dependencies -label:RFC - ``` - -

-
-- [UI5 Tooling - Bug Triage](https://github.com/orgs/SAP/projects/2) - +
- Card filter for project maintainers -

- - ``` - is:open repo:SAP/ui5-tooling repo:SAP/ui5-cli repo:SAP/ui5-logger repo:SAP/ui5-project repo:SAP/ui5-server repo:SAP/ui5-builder repo:SAP/ui5-fs sort:updated-desc -label:dependencies - ``` - -

-
-- [Open Issues (cross-repo)](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+repo%3ASAP%2Fui5-tooling+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs) -- [Open Pull Requests (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+repo%3ASAP%2Fui5-tooling+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs) +## Content +1. [๐Ÿ“ **Reporting Issues**](#-reporting-issues) +2. [๐Ÿคฉ **Feature Requests**](#-feature-requests) +3. [๐Ÿ” **Analyzing Issues**](#-analyzing-issues) +4. [๐Ÿ’ป **Contributing Code**](#-contributing-code) -## ๐Ÿ” Analyzing Issues -Analyzing issue reports can be a lot of effort. Any help is welcome! ๐Ÿ‘ - -Open the [Bug Triage Project Board](https://github.com/orgs/SAP/projects/2) and look for open issues which require triage, additional work, or a bugfix. -Especially check for issues in the **`Needs Triage`** column, or for issues with the labels **`good first issue`**, **`help wanted`**, or **`information required`**. - -You may be able to add additional or missing information, such as a step-by-step guide on how to reproduce an issue or an analysis of the root cause. In case of the latter, you might even be able to [contribute](#-contributing-code) a bugfix. ๐Ÿ™Œ +### โšก๏ธ Quick Links for Maintainers +- [All Open Pull Requests (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+repo%3ASAP%2Fui5-tooling+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs) +- [Pull Request Queue (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Apr+-label%3Aenhancement+-label%3Adependencies+-label%3ARFC+is%3Aopen+no%3Aassignee+sort%3Aupdated-desc+repo%3ASAP%2Fui5-tooling+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs+repo%3ASAP%2Fgrunt-openui5+repo%3ASAP%2Fless-openui5+repo%3ASAP%2Fconnect-openui5+repo%3ASAP%2Fkarma-openui5+repo%3ASAP%2Fopenui5-sample-app) ## ๐Ÿ“ Reporting Issues -### Not a Bug / Questions -If you need help setting something up, or if you have questions regarding the UI5 Tooling, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/). +### Seeking Help / Not a Bug +If you need help setting something up, or if you have questions regarding UI5 Tooling, please seek help on a community platform like the [SAP Community](https://answers.sap.com/topics/ui5-tooling.html), [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/). -### Requirements for a Bug Report -You are encouraged to use the [issue template](.github/ISSUE_TEMPLATE.md). +### How to Report an Issue +Note that we collect issues for all UI5 Tooling modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [ui5-tooling](https://github.com/SAP/ui5-tooling) repository. 1. **Only UI5 Tooling issues** * Please do not report: * Issues caused by dependencies or plugins. * Issues caused by the use of non-public/internal methods. Only the public methods listed in the API documentation may be used. * Something you do not get to work properly, see [Not a Bug / Questions](#not-a-bug--questions). -2. **No duplicate**: You have searched the [issue tracker](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+repo%3ASAP%2Fui5-tooling+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs) to make sure the bug has not yet been reported. +2. **No duplicate**: You have searched the [issue tracker](https://github.com/SAP/ui5-tooling/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to make sure the bug has not already been reported. 3. **Good summary**: The summary should be specific to the issue. -4. **Current bug**: The bug can be reproduced in the most current version. +4. **Current bug**: The bug can be reproduced in the most current version of the relevant module(s). 5. **Reproducible bug**: There are step-by-step instructions provided on how to reproduce the issue. 6. **Well-documented**: * Precisely state the expected and the actual behavior. @@ -61,6 +32,10 @@ You are encouraged to use the [issue template](.github/ISSUE_TEMPLATE.md). 8. **Only one bug per report**: Open additional tickets for additional issues. 9. **Please report bugs in English.** +We encourage you to follow the issue template that will be presented to you when creating a new issue. + +When you are ready, report your issue here: https://github.com/SAP/ui5-tooling/issues/new + ### Reporting Security Issues We take security issues in our projects seriously. We appreciate your efforts to responsibly disclose your findings. @@ -79,11 +54,12 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi * **`bug`**: This issue is a bug in the code. * **`documentation`**: This issue is about wrong documentation. * **`enhancement`**: This is not a bug report, but an enhancement request. +* **`needs triage`**: This issue needs to be investigated and confirmed as a valid issue that is not a duplicate ##### Status of an open issue: * **`information required`**: The author is required to provide information. * **`good first issue`**: A newcomer may work on this. -* **`help wanted`**: Additional help in analyzing this issue is appreciated. +* **`help wanted`**: Additional help in analyzing this issue is required. ##### Status/resolution of a closed issue: * **`duplicate`**: The issue was already reported somewhere else. @@ -97,10 +73,18 @@ Therefore, we reserve the right to close or to not process insufficient bug repo Bug report analysis support is always very welcome! See [Analyze Issues](#-analyzing-issues). -## Feature Requests -For most feature requests you should create an issue in the related [repository](./README.md#modules). +## ๐Ÿคฉ Feature Requests +You can request most features by creating an issue in the UI5 Tooling repository: https://github.com/SAP/ui5-tooling/issues/new -For bigger features an RFC (Request for Comment) might be necessary. You should always clarify the need for an RFC with the project contributors upfront. You can use [this template](rfcs/0000-template.md) for creating an RFC. +For bigger features an RFC (Request for Comment) might be necessary. You should always clarify the need for an RFC with the project contributors upfront. You could do this either by opening an issue or in our [Slack channel](#seeking-help--not-a-bug). You can use [this template](rfcs/0000-template.md) for creating an RFC. + +## ๐Ÿ” Analyzing Issues +Analyzing issue reports can be a lot of effort. Any help is welcome! ๐Ÿ‘ + +Open the [Bug Triage Project Board](https://github.com/orgs/SAP/projects/2) and look for open issues which require triage, additional work, or a bugfix. +Especially check for issues in the **`Needs Triage`** column, or for issues with the labels **`good first issue`**, **`help wanted`**, or **`information required`**. + +You may be able to add additional or missing information, such as a step-by-step guide on how to reproduce an issue or an analysis of the root cause. In case of the latter, you might even be able to [contribute](#-contributing-code) a bugfix. ๐Ÿ™Œ ## ๐Ÿ’ป Contributing Code ### General Remarks diff --git a/README.md b/README.md index b1652ce1c43..653cae3c354 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-tooling)](https://api.reuse.software/info/github.com/SAP/ui5-tooling) [![OpenUI5 Community Slack (#tooling channel)](https://img.shields.io/badge/slack-join-44cc11.svg)](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/) [![Travis CI Build Status](https://travis-ci.org/SAP/ui5-tooling.svg?branch=master)](https://travis-ci.org/SAP/ui5-tooling) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) ## Resources - [Documentation](https://sap.github.io/ui5-tooling/) diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000000..b416ea5c33a --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,11 @@ +### Support + +If you need help setting something up, or if you have questions regarding UI5 Tooling, please refrain from opening an issue on GitHub. + +Instead, please use one of the following platforms to seek help: + +* The [SAP Community](https://answers.sap.com/topics/ui5-tooling.html) +* [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) +* The [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/). + +If you want to report an issue or request a new feature, please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md#-feature-requests).