mhulse / gh-boiler Goto Github PK
View Code? Open in Web Editor NEWCommon GitHub boilerplate files I use to kick-start new repositories.
License: Apache License 2.0
Common GitHub boilerplate files I use to kick-start new repositories.
License: Apache License 2.0
Move down 10 or 15 on iphone and shift point side of arrow over 1 or 2 px. See iphone for visual.
So, I had a folder named /icons
that was being ignored because of this:
Icon?
Related:
Icon\r
in .gitignore
I guess the solution is to do this instead:
Icon^M^M
GitHub recently pointed all gh-pages
demo pages to a new TLD of .io
.
Example:
http://registerguard.github.io/grunt-boiler/demo/
Update the demo links to use the new TLD.
Jean-Luc Picard was born to Maurice and Yvette Picard in La Barre, France, on July 13, 2305, and dreamed of joining Starfleet.
A dash is added at end.
Fix:
[↥](#table-of-contents)
Just replace space for
.
Related: #44
Just to show how one might go about including a demo in their repository.
Also, make sure your app has a MANIFEST for setup.py to be able to
install non-python files (e.g.: your templates) when you install it
without the -e option. Look at the distutils docs for more details
Also noticed that the +
in this file was not liked by pip
install.
Might be good to include a few examples of GitHub's <hr>
styles.
**
__
_
Other?
Some good cheats here:
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Something a little more robust, like:
Copyright © [FIRST LAST or BUSINESS] [FIRST YEAR]-[CURRENT YEAR]. All rights reserved.
Unauthorized use and/or duplication of this material, without express and written permission from the owner, is strictly prohibited.
This is pretty dope right here:
https://github.com/darcyclarke/Front-end-Developer-Interview-Questions
## <a name='toc'>Table of Contents</a>
1. [Original Contributors](#contributors)
####[[⬆]](#toc) <a name='contributors'>Original Contributors:</a>
https://github.com/gulpjs/gulp
Their read me has centered image:
<p align="center">
<a href="http://gulpjs.com">
<img width="98" height="194" src="https://raw.github.com/gulpjs/artwork/master/gulp.png"/>
</a>
</p>
I think I now prefer having a changelog in the README.md
.
This is the format I think I prefer:
https://github.com/mhulse/bueller
Another example would be Grunt plugin style:
Succinct:
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
Also succinct, and a nice alternative to having (or on top of) a README.md
:
Release History
- 0.4.0 Removed automatic parse, added ability to add ini or json style
src
files- 0.3.0 Automatically parses .env files now
- 0.2.1 fixed npm install
- 0.2.0 grunt 0.4.0 support, simplified
- 0.1.0 Initial release
Found here.
Generic:
sitemap.xml
sitemap.xml.gz*~
.svn
.cvs
*.bak
*.swp
Wordpress:
# http://www.stumiller.me/what-should-be-excluded-in-a-wordpress-gitignore-file/
# Migrate to this type of setup: https://github.com/markjaquith/WordPress-Skeleton
wp-config.php
wp-content/uploads/
wp-content/blogs.dir/
wp-content/upgrade/
wp-content/backup-db/
wp-content/advanced-cache.php
wp-content/wp-cache-config.php
wp-content/cache/*
wp-content/cache/supercache/*
wp-content/cache/
wp-content/backups/
Maybe I should just focus on non-project-specific ignores?
… in the copyright section of the README. UTF8 is good.
# This file is for unifying the coding style for different editors and IDEs.
# EditorConfig is AweSome: http://editorconfig.org/
root = true
[*]
charset = UTF-8
end_of_line = LF
insert_final_newline = true
trim_trailing_whitespace = false
indent_size = 4
indent_style = tab
[*.{py,rst,ini}]
indent_size = 4
indent_style = space
[*.bat]
end_of_line = crlf
[*.json]
indent_size = 2
indent_style = space
Add YML to space list. Basing this issue one Jekyll page:
http://jekyllrb.com/docs/configuration/
Do not use tabs in configuration files
This will either lead to parsing errors, or Jekyll will revert to the default settings. Use spaces instead.
... and not just the repo.
This change makes more sense when there's multiple demo pages to link to (it's odd to duplicate the QR code 3 times, for example, and have it point to one endpoint).
Check out the template here:
Example:
<img align="right" height="260" src="http://gruntjs.com/img/grunt-logo-no-wordmark.svg">
Live example: https://github.com/gruntjs/grunt/blob/master/README.md
For quick copy/paste for small projects.
Whoa, this is cool:
https://github.com/blog/1184-contributing-guidelines
Awesome example:
https://github.com/sapegin/jquery.mosaicflow/blob/master/Contributing.md
Copy/paste here for future quick reference:
I love pull requests. And following this simple guidelines will make your pull request easier to merge.
grunt
or npm test
) to see the tests fail.Example:
'use strict';
function foo(bar, fum) {
if (!bar) return;
var hello = 'Hello';
var ret = 0;
for (var barIdx = 0; barIdx < bar.length; barIdx++) {
if (bar[barIdx] === hello) {
ret += fum(bar[barIdx]);
}
}
return ret;
}
Awesomeness.
gh-boiler
Add:
[CNAME]
insert_final_newline = false
As the CNAME file won't work if newline.
Found this link today:
... and this one too:
Looks like:
Pretty cool!
Add a "submiting an issue" link in the README with the above linkage (to this repo's issue tracker of course).
Like:
16.0.1
, Safari 6.0.1 (8536.26.14)
, Opera 12.02 (1578)
, Chrome 22.0.1229.94
16.0.1
, Chrome 22.0.1229.94 m
, Safari 5.1.7 (7534.57.2)
, Opera 12.02 (1578)
9.0.8112.16421
, IE 8.0.6001.18702
, IE 7.0.6002.18005
6.0.2900.5512.xpsp_sp3_gdr.120504-1619
6.0
:
21.0.1180.82
, Opera Mini 7.0.5.45389
6.0
:
6.0
:
6.0
:
5.1.1
:
While I like what I've done in the latest version of the .gitattributes
file, I'm thinking it might be best to go back to just using:
# https://help.github.com/articles/dealing-with-line-endings
# http://davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/
# https://github.com/Danimoth/gitattributes
* text=auto
... as that's pretty much all that's needed when starting a new project. Everything else is icing on the cake.
Maybe I should ask the folks over here:
https://github.com/Danimoth/gitattributes
... about adding a "catch all" .gitattributes
like:
https://github.com/mhulse/gh-boiler/blob/911c38eff61617e2545eb5493de11d04d1656749/.gitattributes
My question: If I have * text=auto
, do I need to specify that for all the other * text=auto
entries? Considering that the latter is what happens if things are not defined, it seems like specifically defining * text=auto
is overkill. That's why I removed those lines from this commit:
https://github.com/mhulse/gh-boiler/blob/201a28d69914123d9737e13f380cb9aa82441774/.gitattributes
For a django app.
Install using pip
:
$ sudo pip install -e git+https://github.com/registerguard/django-dox.git#egg=django-dox
Add 'dox',
to your installed_apps
setting.
Put this in your URLs:
(r'^pages/', include('dox.urls')),
Run:
$ sudo service apache2 restart
... or:
$ touch apache/django.wsgi
... or whatever you need to do to reload things.
Lastly:
$ python manage.py syncdb
... and you're ready to go!
Enjoy your Django Dox today!
It caused me some headaches when working with Jekyll. I see no reason why the non-gzipped version of a sitemap.xml should be ignored (unless it's going to be auto-generated???).
Removing it.
Check out:
... don't miss:
http://choosealicense.com/no-license/
And this:
https://github.com/blog/1530-choosing-an-open-source-license
I want to add more options to this repo for the above type of stuff.
Add to readme.
Love this:
https://github.com/jchristopher/attachments/blob/master/README.md
Great way to keep a README organized (depending on project).
Like:
https://github.com/gruntjs/grunt/wiki/Contributing
master
directly.grunt
to see the tests fail.grunt
to see if the tests pass. Repeat steps 2-4 until done.Like here: https://github.com/FortAwesome/Font-Awesome
Good idea to link changelog to milestone for that version/release.
I kinda like that file name better than CHANGELOG.md
. Having both in this repo would work for me.
Example:
Need to add WIKI entry, or something, on my preferred style.
Make it generic, like the CONTRIBUTORS.md
file.
This:
## vX.X.X
#### Mmmmm [D]D, YYYY
Shoulde be this:
## vX.X.X
#### Mmmmm [D]D, YYYY
It's a small change, but makes sense if I have multiple dates under a version heading. Also, the styles push it down anyway, so there's no reason to have the two so close together.
node_modules
npm-debug.log
.DS_Store
# Compiled source: #
####################
*.com
*.class
*.dll
*.exe
*.o
*.so
*.pyc
# Packages: #
#############
# It's better to unpack these files and commit the raw source git has its
# own built in compression methods:
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip
# Logs and databases: #
#######################
*.log
*.sql
*.sqlite
# OS generated files: #
#######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
# Project-specific: #
#####################
Syntax section should be a part of the contributing header.
So I can easily package apps.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.