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

Added an ISSUE_TEMPLATE.md for issues #89

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

Gum-Joe
Copy link

@Gum-Joe Gum-Joe commented Jun 8, 2016

Hi,
I've added an issue template for issues.
If you want me to, I can add an CONTRIBUTING.md or pull request template.
Feel free to check the issue template out and make any modifications if needed.

Hope this gets merged!
P.S. Great Project!

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 8, 2016

Just realised: Need to add a script to remove the template, as it is not for everyone. Please do not merge.

@sahat
Copy link
Owner

sahat commented Jun 8, 2016

Thanks @Gum-Joe, will wait on your changes.

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 8, 2016

Thanks for being patient @sahat

moflo and others added 3 commits June 8, 2016 22:57
Build error on react-redux requiring react-dom 15.1.0, and lodash 4.13.1 for npm build boilerplate options.

Thanks!
Update npmDependencies.json
@execat
Copy link

execat commented Jun 9, 2016

Correct how "Jekyll" is spelled please.

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 9, 2016

Ok

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 10, 2016

@sahat I've added all my commits. As there are no conflicts, you can safely to merge this pull request.
Notes on the bootstrap script:

  • I have stored it in generators/util/bootstrap.js. It is ran by script/bootstrap.
  • As I did not know where to put generators/util/bootstrap.js to be ran, I created script/bootstrap to bootstrap on npm install, but did not add it as a script in case it ruined the development environment.
  • You could add generators/util/bootstrap.js as a script ran after a generator.
  • I created the generators/util directory to store the utils for generating in. You may want to separate out generators/utils.js into separate files in generators/util
  • The script can also be used to make files:
// File generators/util/bootstrap.js
// Files to make
const newfiles = [
  // Place file names in this format:
  // { name: 'file', content: 'file' }
];

Fix spelling of jekyll in ISSUE_TEMPLATE.md
@@ -17,7 +17,7 @@
- [ ] Other: put-it-here
- Framework:
- [ ] Express
- [ ] Jenkyll
- [ ] Jekyll
Copy link

Choose a reason for hiding this comment

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

Thanks!

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 14, 2016

@execat Your welcome

@Gum-Joe
Copy link
Author

Gum-Joe commented Jun 21, 2016

Hi,
This pull request has been open for 2 weeks, yet not merged. Is there anything missing?

@sahat
Copy link
Owner

sahat commented Jul 1, 2016

@Gum-Joe Hey, I was just a little confused with the bootstrap function, how is it related to ISSUE_TEMPLATE.md?

Also, I am kind of new to these GitHub templates. Is there any way for me to test it before merging?

@Gum-Joe
Copy link
Author

Gum-Joe commented Jul 1, 2016

@sahat First of all, I am very sorry for being impatient and wanting my pull request to be merged quite quickly.

The bootstrap function is supposed to remove files that the end user (the one generating the boiler plate) does not need, in this case ISSUE_TEMPLATE.md, as it is for this repo (sahat/megaboilerplate). Also, it create new files for the end user, such as a minimal CONTRIBUTING.md.

Testing ISSUE_TEMPLATE.md is a bit tedious. First, open up a new repo (make sure to give it a description that tells the user to ignore the repo) or make a private repo if you are on a plan, then copy the contents of ISSUE_TEMPLATE.md into a new ISSUE_TEMPLATE.md in that repo. Commit the file. Open up a issue, and you should see it already filled. If you go through it, you should see check boxes and commented instructions on what to do. Complete the template as if you are making an issue yourself for your repo. To check the formatting, click the preview button. All the comments should not appear, the info should be in place and some of the check boxes should be ticked.

@sahat sahat added the In Review label Jul 7, 2016
@sahat sahat removed the In Review label Sep 4, 2016
@Gum-Joe
Copy link
Author

Gum-Joe commented Jan 11, 2018

Hello @sahat. It's been ~1.5 years since this PR was opened and nothing has happened since. Is it worth keeping this PR open, or should it be closed?

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.

4 participants