Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Issue and Pull Request templates

github.com

Post reply on HN
Print view View original

101–110 of 143 posts

Re: Issue and Pull Request templates

#101

Post by sytse »

joshmanders wrote: post #76
icholy wrote: post #65

Earlier quoted context omitted.

I totally get where you're coming from. An extra file in your repository is quite the burden. This template file is the straw that broke the camels back. It should be removed. But why stop there? Let's also remove the README.md from the repo. It can also have it's own independent revision history. Maybe they should also add a feature for managing the LICENSE file for you. /sarcasm

Except that CONTRIBUTING.md and README.md and LICENSE are all typical files found in a repo that are independent of GitHub. If I push this repo to bitbucket or gitlab, the same stuff is just as important. But `issue_template.md` and `pull_request_template.md` is only dependent on github and is clutter in the repo. Sure if gitlab or bitbucket have these features and use those names, cool it translates to those service…

We plan to support both .github and .gitlab in GitLab https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2864

Re: Issue and Pull Request templates

#102

Post by sytse »

0xffff2 wrote: post #88
pducks32 wrote: post #87

I'd like them to choose a folder name that isn't specific to a site. .github would look silly on hit lab but I like the idea of having a serrated folder.

Trying to use a GitHub only feature on GitLab would look equally silly... This is very much a GitHub specific implementation. It makes sense for it to be identified as such. It would be nice if they used a specific branch a la gh-pages so that everyone's Git repos don't have to be polluted with GitHub specific files.

We plan to support both .github and .gitlab in GitLab https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2864

Re: Issue and Pull Request templates

#103

Post by logn »

skeoh wrote: post #92
logn wrote: post #79

The problem I have with this is, I don't want a template for the comment a contributor leaves on a PR; I want to display a message to them before they submit a PR. It's not a standard way to display messages, requiring users to read editable text (that has no clickable URLs) and then delete that text after they read it and submit.

Does CONTRIBUTING.md fulfil this requirement?

Thanks. Wasn't aware of that. Mostly fulfills the requirement.

Re: Issue and Pull Request templates

#104

Post by OJFord »

ossreality wrote: post #58
jamesRaybould wrote: post #31

Earlier quoted context omitted.

I don't think so, it seems like its just a link to what you can see within the UI anyway and simply pre selects it for you. But I am by no means an expert on it and it is pretty simple to experiment with if you want to give it a try

People who aren't owners can't normally add labels.

They presumably still can't via the URL.

Re: Issue and Pull Request templates

#106

Post by JBiserkov »

makecheck wrote: post #60
aidenn0 wrote: post #33

Earlier quoted context omitted.

Would you seriously rather have it unversioned and untracked and managed with some random webpage on github?

Something only belongs in the same branch as the code if it should be forever tied to the same version as the other files in that branch. Suppose I check out a project using a version from a year ago. Project maintainers would certainly not expect me to use last year’s issue template, last year’s preferred pull request layout and last year’s rules for contributing! That is why shoving things into the "git" repository…

Last time I checked the Wiki was a separate, parallel repository, so a precedent exists. I'm not sure where it fits in your classification (code/documentation or project management).

Re: Issue and Pull Request templates

#107

Post by JBiserkov »

swang wrote: post #13

Kinda meh on adding it to the repo since it's yet another file I have to "manage" that isn't really part of the working code.

I agree. At least they made a way to separate GitHub stuff:

>If you're worried about the added clutter in the root directory of your project, we also added support for a .github/ folder. You can put CONTRIBUTING.md , ISSUE_TEMPLATE.md , and PULL_REQUEST_TEMPLATE.md files in .github/ and everything will work as expected

Re: Issue and Pull Request templates

#108

Post by JBiserkov »

dhagz wrote: post #100
nvk wrote: post #15

Earlier quoted context omitted.

Many large FOSS projects (which this is aimed for) already have CONTRIBUTING.md etc... I personally prefer this non UI/Github specific approach.

I agree. This gives other git hosting providers the ability to implement the same feature using the same files.

Yes. Yet it's a bit weird in case .github folder is used. Will they support a .bitbucket, .gitlab, etc. They could have used a more generic name like .contributing, but this increases the risk of name collision.

Re: Issue and Pull Request templates

#109

Post by acdha »

badlogic wrote: post #54
thescribe wrote: post #51

This sounds like more 'enterprise' bureaucracy. Coming soon, overly complicated paperwork.

If you've ever managed a big OSS project you'd not think of it like 'enterprise' bureaucracy but a time safer. If OSS users can't even be asked to fill out a minimum amount of information based on a template, then I have zero interest spending my free time helping out.

Yes, OSS users have a very wide gamut — for everyone who sends a pull request with good troubleshooting and a patch, there must be half a dozen people who click New Issue, submit minimal information and, if you're lucky, come back a couple of days later and acknowledge that the real problem was a hacked up local install, using a 5 year old version of a core dependency, etc.
Post reply on HN