gitevents / core

GitEvents core; manage your user group with GitHub
MIT License
41 stars 19 forks source link

Cosmetic: Too many files in root #143

Open martinheidegger opened 8 years ago

martinheidegger commented 8 years ago

This is somewhat an cosmetical issue.

On github there are a lot of files in the repository's root. So many that the readme is way down the screen. It would be "nice" to see it a on the first look. Here is how much fits my screen: screenshot 2016-01-12 06 18 21

PatrickHeneise commented 8 years ago

yeah I've realised the same today. We could remove:

Snyk I'd like to give a test run for security checks, hound I'd like to keep to have code-style constraints at least on the core. Code climate is nice to have?

PatrickHeneise commented 8 years ago

Apart from that I think functionality over design, even though the front-page doesn't look as great, those files help a lot ;)

martinheidegger commented 8 years ago

My thinking: Files that could be in subfolders: roadmap.md, todo.md, review.md, github-credentials-example.js, init.sh Files that could be substituted: contributors.md -> package.json(contributors field)

alistairstead commented 8 years ago

What about using semistandard as a dev dependency? This would allow the removal of much of these tool config files.

PatrickHeneise commented 8 years ago

seems like a nice tool but is yet another linter to install. I provided consistent jshint/jslint/jscs/jsbeautifyrc as everyone works with different tools and linters and still provide consistent formatting.

alistairstead commented 8 years ago

Well yes it is an alternative tool but it means that you ship one tool with the project that fullfils all of these functions. It simplies things by reducing the options and therefore complexity and maintenance overhead.

I'm new to the conversation so obvioulsy lots of effort has already been expended that should not be thrown away.

mike182uk commented 8 years ago

I think it would be best to adopt just one tool (set of tools) and make sure this is installed as a dev dependency and run on the CI server. This would reduce the maintenance needed in supporting multiple tools and make it easier for contributors to contribute.