Skip to content
This repository has been archived by the owner on Sep 23, 2021. It is now read-only.

Cosmetic: Too many files in root #143

Open
martinheidegger opened this issue Jan 11, 2016 · 7 comments
Open

Cosmetic: Too many files in root #143

martinheidegger opened this issue Jan 11, 2016 · 7 comments

Comments

@martinheidegger
Copy link
Contributor

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
Copy link
Member

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

  • .eslintrc
  • .editorconfig
  • .jshintignore

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
Copy link
Member

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

@martinheidegger
Copy link
Contributor Author

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
Copy link
Contributor

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

@PatrickHeneise
Copy link
Member

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
Copy link
Contributor

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
Copy link
Contributor

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants