Git Product home page Git Product logo

gh-boiler's People

Contributors

mhulse avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gh-boiler's Issues

Page arrows

Move down 10 or 15 on iphone and shift point side of arrow over 1 or 2 px. See iphone for visual.

Map center

Jean-Luc Picard was born to Maurice and Yvette Picard in La Barre, France, on July 13, 2305, and dreamed of joining Starfleet.

Manifest enhancements ...

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

Discussion here.

Also noticed that the + in this file was not liked by pip install.

No license

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.

Check gulp repo

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>

Found tidbits

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.

Post example of multiple qr codes in a MarkDown table

For example:

DEVELOPMENT PRODUCTION
qr code qr code

... of course, change the endpoints to something in the gh-boiler repo.

Note: When there's three or more QR codes, the size needs to be tweaked. 200x200 works better when 3 in a row. Wondering if 200x200 should be the default size?

.gitignore additions

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?

Editor config tweaks

# 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

QR codes should point to actual demo page ...

... 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).

Contributing guidelines

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:


How to contribute

I love pull requests. And following this simple guidelines will make your pull request easier to merge.

Submitting pull requests

  1. Create a new branch, please don’t work in master directly.
  2. Add failing tests (if there’re any tests in project) for the change you want to make. Run tests (usually grunt or npm test) to see the tests fail.
  3. Hack on.
  4. Run tests to see if the tests pass. Repeat steps 2–4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.

JavaScript code style

  • Tab indentation.
  • Single-quotes.
  • Semicolon.
  • Strict mode.
  • No trailing whitespace.
  • Variables where needed.
  • Multiple variable statements.
  • Space after keywords and between arguments and operators.
  • Use === and !== over == and !=.
  • Return early.
  • Limit line lengths to 120 chars.
  • Prefer readability over religion.

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;
}

Other notes

  • If you have commit access to repo and want to make big change or not sure about something, make a new branch and open pull request.
  • Don’t commit generated files: compiled from Stylus CSS, minified JavaScript, etc.
  • Install EditorConfig plugin for your code editor.
  • If code you change uses different style (probably it’s an old code) use file’s style instead of style described on this page.
  • Feel free to ask me anything you need.

Awesomeness.

Editor config: CNAME

Add:

[CNAME]
insert_final_newline = false

As the CNAME file won't work if newline.

Create an issue with body filled in

Add browser test template to CHANGELOG.md

Like:

Browser tests:
  • MAC Snow Leopard:
    • Firefox 16.0.1, Safari 6.0.1 (8536.26.14), Opera 12.02 (1578), Chrome 22.0.1229.94
  • PC Vista:
    • Firefox 16.0.1, Chrome 22.0.1229.94 m, Safari 5.1.7 (7534.57.2), Opera 12.02 (1578)
    • IE 9.0.8112.16421, IE 8.0.6001.18702, IE 7.0.6002.18005
  • PC XP:
    • IE 6.0.2900.5512.xpsp_sp3_gdr.120504-1619
  • iPhone (Retina 4-inch):
    • Safari (simulated)
  • iPhone (Retina 3.5-inch), iOS 6.0:
    • Safari (simulated), Safari, Chrome 21.0.1180.82, Opera Mini 7.0.5.45389
  • iPhone, iOS 6.0:
    • Safari (simulated)
  • iPad (Retina), iOS 6.0:
    • Safari
  • iPad, iOS 6.0:
    • Safari (simulated)
  • iPad, iOS 5.1.1:
    • Safari

Gitattributes

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

Installation instructions ...

For a django app.

Example:

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!

Remove sitemap.xml from .gitignore

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.

Contributing note

Like:

https://github.com/gruntjs/grunt/wiki/Contributing

Submitting pull requests

  1. Create a new branch, please don't work in master directly.
  2. Add failing tests for the change you want to make. Run grunt to see the tests fail.
  3. Fix stuff.
  4. Run grunt to see if the tests pass. Repeat steps 2-4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.

Tweak CHANGELOG.md

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.

Slight update to .gitignore formatting

# 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: #
#####################

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.