Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(github): Update issue template to use external main che repository #750

Merged
merged 1 commit into from
Jul 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/where-to-report-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "⚠️ Where to report issues?"
about: File issues in the main Eclipse Che repository at https://github.com/eclipse/che/issues
title: Issues need to be filed in the main Eclipse Che repository
labels: ''
assignees: ''

---

## Where to report issues?

This repository is not the primary repository of Eclipse Che.

🚨 Please don't submit new issues here. 🚨
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
🚨 Please don't submit new issues here. 🚨
🚨 Please don't submit new issues that are not related to documentation in this repository. 🚨

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rkratky : getting consistent with the others Che repositories, we want to have a single place to consolidate the backlog and make it easier to the community to look for issues/feedbacks/enhancements. There is a kind/docs label on eclipse/che repo which should be used appropriately.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slemeur I find it highly unintuitive to file issues about the content of a repo in a different repo. It also prevents us from fully using GH features that simplify work on PRs and issues when handled 'normally', i.e. through the issue queue of respective repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here I would still say that it's "no issues at all" as it was decided that all issues should be in eclipse/che repository

Issues should have area/doc label in eclipse/che

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was decided

Where?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd send it as soon as possible. It's a significant process change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mail sent

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole point is simplicity and consistency for the community and users.
If someone wants to create an issue, there will be a single backlog which give an easier way to get visibility on what's going on. The use of labels and milestone will be easier to manage too.
If someone is looking at all the issues resolved for a given milestone, until having a single backlog, he/she would have to do a request across dozen of repositories.
It is also very inconvenient when someone is looking at if an issue already exist.

One last point, we currently have issues for docs on github.com/eclipse/che repo, I'm doubtful we've been able to manage these two spread backlogs in sync.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the reasoning (and I agree with it). But I believe the wrong tool was chosen. GH issues are specifically tailored for working with respective repositories. Tracking issues for multiple repos in one issue queue doesn't scale. As a general-purpose issue tracker, GH issues sucks.

For such purpose, an external issue tracker should be used. GH issues is severely limited in functionality -- for example, the inability to filter issue notification mails in any way makes it impossible track project areas efficiently. One always needs to open the list of issues on the web just to check if new issues were created for a particular label.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a fair point @rkratky.
For the committers it will require a bit more effort, but for the community and users, it will become cleaner and simpler.


All issues for Eclipse Che are managed at [https://github.com/eclipse/che/issues](https://github.com/eclipse/che/issues).
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ pass:[VARIABLE_NAME__WITH__UNDERSCORES]

## How to get support

* **GitHub issue:** [open an issue](https://github.com/eclipse/che-docs/issues/new) in this repository
* **GitHub issue:** [![New questions](https://img.shields.io/badge/New-question-blue.svg?style=flat-curved)](https://github.com/eclipse/che/issues/new?labels=area/doc,kind/question)
[![New bug](https://img.shields.io/badge/New-bug-red.svg?style=flat-curved)](https://github.com/eclipse/che/issues/new?labels=area/doc,kind/bug)

* **Public Chat:** Join the public [eclipse-che](https://mattermost.eclipse.org/eclipse/channels/eclipse-che) Mattermost channel to talk to the community and contributors

## How to contribute
Expand Down