search

mintel / repo-boilerplate

A boilerplate for a Git Repo at Mintel
MIT License
0 stars 0 forks source link

Example boilerplate for opensource projects #1

Open nabadger opened 6 years ago

nabadger commented 6 years ago

@jtdoepke @Greatlemer let me know what you think - feel free to modify as needed.

Also let me know if you want to change the repo name.

The idea of this repo is to act as a boilerplate for any opensource (and ideally internal) projects we do.

I'm not sure whether we could do this with a cookiecutter or not (it may be overkill?). Keep in mind this boilerplate should not be specific to any language.

I'm also not sure what we should regarding the LICENSE file, as we'll have 2 or 3 options (but in most cases it'll be MIT).

I'd request people from the chapters to get involved on this as well (as soon as we send around our opensource policy docs).

jtdoepke commented 6 years ago

.editorconfig and .gitignore are so language-specific I'm not sure they should be included. Although we really do want them in every project. Not sure how to do that without breaking out into language-specific templates.

jtdoepke commented 6 years ago

And I do think we should have a cookiecutter for the most common case: a Python package.

nabadger commented 6 years ago

I've set an empty .gitignore.

I've kept .editorconfig and removed the global indent_size. I'm not sure anything else in that file is language-specifc, but even if it is - editorconfig supports language-specifc formatting.

Let's see what other teams think. I know Adam was really interested in this...