Skip to content

Revised guidelines for GitHub issues#6327

Merged
Noiredd merged 5 commits intoBVLC:masterfrom
Noiredd:meta-contrib-guidelines
Apr 10, 2018
Merged

Revised guidelines for GitHub issues#6327
Noiredd merged 5 commits intoBVLC:masterfrom
Noiredd:meta-contrib-guidelines

Conversation

@Noiredd
Copy link
Member

@Noiredd Noiredd commented Apr 3, 2018

Inspired by @williford's idea for a submission checklist, I propose the following changes to ISSUE_TEMPLATE and CONTRIBUTING:

  • Default template for issues will contain a checklist with issue requirements; the user's responsibility will be to make sure every position on the list is ticked before they submit the issue. Hopefully this will result in issues of higher quality and easier to solve.
  • The list of requirements for issues is moved entirely to contributing guidelines (CONTRIBUTING). The issue template will only redirect the user to this file, while the first position on the checklist requires them to read it.
  • One new requirement is that issues do not contain overly long pieces of code, config files, or logs; these should be attached instead. It is somewhat opinion-based, as for me it is uncomfortable to scroll through a long post (I prefer to open the relevant files on another monitor), so feel free to discuss that.

I intended the checklist to be intuitive more than specific, so that we don't have to start with a strict enforcement (something like "make sure to go through the following list as issues without all the ticks will be dismissed"), so any suggestions about wording are welcome.

Another thing I consider in addition to the above is a new header in the template: "Tried solutions". Some issues are similar to others, and this would at least (attempt to) prompt users to do some research, hopefully making the work easier for us.

Note to self: add the requirement to include which fork and version of Caffe is being used.

@Noiredd
Copy link
Member Author

Noiredd commented Apr 3, 2018

Side note - the filler tests seem to randomly fail. I swear this PR doesn't touch them ;)

[ FAILED ] GaussianFillerTest/1.TestFill2D, where TypeParam = double

Maybe the tolerance should be upped a notch or two. Restarting it in the meantime.

@Noiredd
Copy link
Member Author

Noiredd commented Apr 10, 2018

I've added some additional guidelines for user list posts and attempted to consolidate links to places where users can look for solutions to their problems. Hopefully this will make it easier for users to make use of the existing knowledge, and increase the quality of questions on the users list as well.
The "tried solutions" check for issue template was also added.

Let me know your opinions, or approval if this is good to merge as is.

For easy preview of the changes, shortcuts to my branch: CONTRIBUTING.md, ISSUE_TEMPLATE.md.

@shelhamer
Copy link
Member

Note to self: add the requirement to include which fork and version of Caffe is being used.

This is worth including since it is sometimes overlooked even though it is usually obvious to diagnose as the poster will reference a layer/solver/etc. that does not exist in BVLC/caffe:master. Thanks for adding a note about this in the guidelines.

@Noiredd Noiredd merged commit 106bfcf into BVLC:master Apr 10, 2018
@Noiredd Noiredd deleted the meta-contrib-guidelines branch April 10, 2018 22:20
sjb7749 pushed a commit to sjb7749/caffe that referenced this pull request Jul 2, 2018
revised guidelines for GitHub issues and caffe-users posts
XinYao1994 pushed a commit to XinYao1994/caffe that referenced this pull request Aug 29, 2018
revised guidelines for GitHub issues and caffe-users posts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants