Skip to content
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
19 changes: 11 additions & 8 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<!--
Issues without reproductions will be closed. To create a repro,
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs

1. Use https://rollupjs.org/repl, or
2. Follow the instructions in https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d70ff
❤️ Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate

If you just require tech support, please avoid creating issues! Though we would love to help you, we have very limited resources. Answering support questions prevents us from fixing bugs and implementing new features. Instead
Ahoy!

* search or post a question to https://stackoverflow.com/questions/tagged/rollupjs
* ask for help on https://gitter.im/rollup/rollup
You're seeing this because you felt none of the other options fit the type of
issue you'd like to create. Please use this opportunity to tell us about the
type of issue you were looking for, so we can try to accommodate similar
issues in the future.

Love Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate
If you're using this template to report an issue covered by an existing issue
type, we'll close it as invalid faster than you can spell 'Mississippi'.
-->
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: 🐞 Bug Report
about: Something went awry and you'd like to tell us about it.

---

<!--
⚡️ katchow! We 💛 issues.

Please - do not - remove this template.
Please - do not - skip or remove parts of this template.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If we leave this line here, then it should be made clear which parts can be skipped if they do not apply. See below.

Or your issue may be closed.

👉🏽 Need help or tech support? Please don't open an issue!
Head to https://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs

❤️ Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate
-->

- Rollup Version (if applicable):
- Operating System (or Browser):
- Node Version:
- NPM Version:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Rollup has no runtime dependencies so we could remove the npm version, unless they are having TypeScript typing issuese.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's reasonable. Will update.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd say the Rollup version is always relevant. The second line could be:

  • Operating System + Node Version (or other Runtime Environment/Browser):

And I agree, the NPM version will probably not be relevant as all NPM specific functionality is usually handled by rollup-plugin-node-resolve.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm down with removing the NPM version as a requirement, especially given how Rollup is shipped.


### How Do We Reproduce?

<!--
Issues without minimal reproductions will be closed! Please provide a repro by:
1. Using the REPL at https://rollupjs.org/repl, or
2. Provide a repository link (Read https://git.io/fNzHA for instructions)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I hate repository links, as it always seems like a great way to put a backdoor onto a maintainers machine to me (npm install is executing).

2. Work to isolate the issue and write out the exact steps in the issue here.
3. Include a minimal GitHub repo link. These may take more time for us to look into than the above.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm good with this change. For consensus @lukastaegert please weigh in on it (Lukas had previously asked for the REPL and repo link in order from the template on master).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think I am ok with @guybedford's change as it would still encourage the creation of a repo albeit with lower priority. From the debugging perspective, they can be a huge shortcut but I see the security concerns.

Maybe in the future we could work to extend the REPL to be able to reproduce more situations by adding a way to designate multiple entry points (maybe a simple checkbox above each module?) and some way (cogwheel button?) to provide a select set of config options that would make sense here.

-->


### Expected Behavior


### Actual Behavior


<!--
Most issues can be expressed or demonstrated through the REPL or a repository.
However, the situation may arise where some small code snippets also need to
be provided. In that situation, please add your code below using
Fenced Code Blocks (https://help.github.com/articles/creating-and-highlighting-code-blocks/)
-->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍



33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 📚 Documentation
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.

---

<!--
⚡️ katchow! We 💛 issues.

Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.

👉🏽 Need help or tech support? Don't open an issue!
Head to https://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs

❤️ Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate
-->

Documentation Is:

<!-- Please place an x (no spaces!) in all [ ] that apply -->

- [ ] Missing
- [ ] Needed
- [ ] Confusing
- [ ] Not Sure?

### Please Explain in Detail...


### Your Proposal for Changes
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: ✨ Feature Request
about: Suggest an idea for this project

---

<!--
⚡️ katchow! We 💛 issues.

Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.

👉🏽 Need help or tech support? Please don't open an issue!
Head to https://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs

❤️ Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate
-->

### Feature Use Case


### Feature Proposal
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/MODIFICATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: 🔧 Modification Request
about: Would you like something work differently? Have an alternative approach? This is the template for you.

---

<!--
⚡️ katchow! We 💛 issues.

Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.

👉🏽 Need help or tech support? Please don't open an issue!
Head to https://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs

❤️ Rollup? Please consider supporting our collective:
👉 https://opencollective.com/rollup/donate
-->


### Expected Behavior / Situation


### Actual Behavior / Situation


### Modification Proposal
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: 🆘 Support, Help, and Advice
about: 👉🏽 Need help or tech support? Please don't open an issue! Head tohttps://gitter.im/rollup/rollup or https://stackoverflow.com/questions/tagged/rollupjs.

---

Hey there! If you need help or tech support then this is not the place to
ask. Please head to [the Rollup Gitter](https://gitter.im/rollup/rollup)
instead or post a question to https://stackoverflow.com/questions/tagged/rollupjs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe we could add something like: If you think Rollup's documentation is unclear, insufficient or wrong, consider creating an issue for the documentation instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done, nearly verbatim.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍


If you arrived here because you think Rollup's documentation is unclear,
insufficient or wrong, please consider creating an issue for the documentation
instead.
39 changes: 35 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
<!--
Thank you for creating a pull request. Before submitting, please note the following:
⚡️ katchow! We ❤️ Pull Requests!

* If your pull request implements a new feature, please raise an issue to discuss it before sending code. In many cases features are absent for a reason.
* This message body should clearly illustrate what problems it solves. If there are related issues, remember to reference them.
* Ideally, include a test that fails without this PR but passes with it. PRs will only be merged once they pass CI. (Remember to `npm run lint`!)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These guidelines seem important to me to keep. Or perhaps reword into the template?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The first point (about an accompanying issue) I've found that with new features, there's often more work done on implementation before discussion starts, if the contribution is coming from outside contributors, which is then discussed directly on the PR. I've also found it can be a hinderance to contribution if there's too much process but I'm completely OK with adding that back in. If you feel there's more value to the process than risk of dissuading contributions, I'm good with that.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can get behind what you're saying certainly in not crowding the process here.

Perhaps a note saying they should research previous discussion on the feature by searching the issues first?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Great idea. Definitely a step that should always happen.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Committed proposed additions based on that feedback.

If you remove or skip this template, you'll make the 🐼 sad and the mighty god
of Github will appear and pile-drive the close button from a great height
while making animal noises.

Pull Request Requirements:
* Please include tests to illustrate the problem this PR resolves.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Huge thumbs up from me for making this the top priority! Hope at some point to write up a short guide to writing tests that we could link to from here.

* Please lint your changes by running `npm run lint` before creating a PR.

Please place an x (no spaces - [x]) in all [ ] that apply.
-->

This PR contains:

- [ ] bugfix
- [ ] feature
- [ ] refactor
- [ ] tests
- [ ] documentation
- [ ] metadata

### Breaking Changes?

- [ ] yes
- [ ] no

If yes, please describe the breakage.

### Please Describe Your Changes

<!--
Please be thorough and clearly explain the problem being solved.
* If this PR adds a feature, look for previous discussion on the feature by searching the issues first.
* Is this PR related to an issue?
-->