Skip to content

Update issue templates #1112

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

Merged
merged 3 commits into from
Feb 8, 2020
Merged

Update issue templates #1112

merged 3 commits into from
Feb 8, 2020

Conversation

Siemienik
Copy link
Member

@Siemienik Siemienik commented Feb 4, 2020

We have a lot of bugs reported which has a poor description, it does not help us to reproduce and fix it quickly.
So I think the issue template should improve the situation :)

@alubbe
Copy link
Member

alubbe commented Feb 6, 2020

I think that's a great idea, but I believe it needs to be short - otherwise users might end up ignoring it. Personally, I like https://raw.githubusercontent.com/facebook/jest/master/.github/ISSUE_TEMPLATE/bug.md so I've shortened our template to be similar to that. What do you think?

Also pinging @guyonroche

@Alanscut
Copy link
Member

Alanscut commented Feb 6, 2020

why not also add a PR template ?😃

@Siemienik
Copy link
Member Author

Siemienik commented Feb 6, 2020

@Alanscut yeah it's great idea:)

@Siemienik
Copy link
Member Author

Siemienik commented Feb 6, 2020

@alubbe for me the important thing is to give me a test which will fail before fixation. We have a lot of bugs reported, that we need a lot of time to inspect and analyze them.

Test code for an issue will give us:

  1. set the quality of issues to the highest level
  2. reduce the fixation time cost
  3. encourage to creating new PRs (if someone makes a test it will probably make a fixation :) )

In the other side, You have right, the short template should increase bug reports amount.
So I have shared my thoughts with you, and I'm really open to change my vision to something else 😄

@alubbe @Alanscut what do you think?

@alubbe
Copy link
Member

alubbe commented Feb 8, 2020

I completely agree, that's why I tried to find a 'middle-ground' approach, that both looks short, so that it actually gets read instead of deleted, but still wants a code example. That's not as much as a fully blown test case, but it's close enough. Here's my suggestion:

## Steps To Reproduce

<!-- The exact steps required to reproduce the issue, ideally with a code example and an expectation (like in a unit test) -->

```javascript
const wb = new ExcelJS.Workbook();
const ws = wb.addWorksheet('XYZ');
ws.getCell('A1').value = 7;
expect(ws.getCell('A1').value).to.equal(7);

@Siemienik Siemienik merged commit b5fe6a1 into master Feb 8, 2020
@alubbe alubbe deleted the f/bug-template branch February 12, 2020 07:21
@alubbe
Copy link
Member

alubbe commented Feb 13, 2020

@Alanscut this PR adds more templates: #1128

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy