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

Update GitHub template files #547

Merged
merged 5 commits into from
Aug 22, 2020
Merged

Update GitHub template files #547

merged 5 commits into from
Aug 22, 2020

Conversation

seratch
Copy link
Member

@seratch seratch commented Aug 21, 2020

Summary

This pull request updates the template files under .github to streamline communications with contributors.

Requirements (place an x in each [ ])

@seratch seratch added the docs M-T: Documentation work only label Aug 21, 2020
@seratch seratch added this to the 1.x milestone Aug 21, 2020
@seratch seratch self-assigned this Aug 21, 2020
@codecov
Copy link

codecov bot commented Aug 21, 2020

Codecov Report

Merging #547 into main will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##               main     #547      +/-   ##
============================================
+ Coverage     83.77%   83.81%   +0.04%     
  Complexity     2695     2695              
============================================
  Files           297      297              
  Lines          7191     7191              
  Branches        611      611              
============================================
+ Hits           6024     6027       +3     
+ Misses          803      799       -4     
- Partials        364      365       +1     
Impacted Files Coverage Δ Complexity Δ
...i/methods/metrics/impl/MemoryMetricsDatastore.java 91.54% <0.00%> (-0.71%) 41.00% <0.00%> (-1.00%)
...pi/methods/metrics/impl/RedisMetricsDatastore.java 89.50% <0.00%> (+2.46%) 38.00% <0.00%> (+1.00%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 31b247e...8712e7b. Read the comment docs.

@aoberoi
Copy link

aoberoi commented Aug 21, 2020

I'd like to think through a few questions before we move forward with this. If issues are created with a label already applied, how does this affect our triage process?

For example, if someone creates a enhancement issue, but it actually describes a bug, that issue might sit in the "To Do" column of our project for a while before anyone devotes time to looking at it.

Should we still consider these issues untriaged until a human has taken a look?

There doesn't seem to be a catch-all choice. If the person who is posting an issue doesn't know which type their issue should be, what will happen? I'd like to keep the friction to creating an issue as low as possible, so nobody feels "not smart enough" to send us their thoughts.

Side note: Maybe we should remove the checklist from the "Requirements" section. Maybe we just leave an HTML comment section that says something along the lines of "Please read the Contributing Guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to the those rules."

Also, maybe we should remove the headings like ### Description? Whenever these issues are rendered in other systems that abbreviate/summarize (like Slack notifications), these headings take up space that could be better used to show the contents of the issue.

@seratch
Copy link
Member Author

seratch commented Aug 21, 2020

Thanks! I can agree with all the suggestions. I will update the templates and do the same for python-slackclient and bolt-python.

@seratch
Copy link
Member Author

seratch commented Aug 21, 2020

@aoberoi Updated. If the latest revision looks good to you, could you approve this? I will be merging this soon.

@seratch seratch merged commit bd7c2b8 into slackapi:main Aug 22, 2020
@seratch seratch deleted the dot-github branch August 22, 2020 04:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants