Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history 
Rough draft!
  • Loading branch information
@Ishub
Ishub committed Feb 5, 2016
1 parent b548ab5 commit 699137b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# repomixer
Check your repository health

List of checks:

1. README.md - Must not be git default
2. LICENSE
3. CONTRIBUTING.md
4. .travis.yml

This comment has been minimized.

Sign in to view

Copy link
@abbycabs

abbycabs Feb 6, 2016

I'm not sure if all projects need to use Travis -- not everything needs a build step (static sites, curriculum projects)

Otherwise, this is a great list! You might be interested in seeing our list of requirements to get on Mozilla Science Collaborate:
mozillascience/plan#47 (comment)

This comment has been minimized.

Sign in to view

Copy link
@onyb

onyb Feb 6, 2016

Owner

We have marked the Travis CI status as a "nice to have", not an absolute requirement. We are using a severity level for each check to indicate this.

This comment has been minimized.

Sign in to view

Copy link
@abbycabs

abbycabs Feb 10, 2016

Thanks -- that sounds like a good approach!
5. Travis build status
6. .gitignore
7. Test Cases

The application works with the Repository url. The python scripts runs above checks to rate your project on the basis of collaborative friendliness of the project.

More checks can be implemented as we progress!

0 comments on commit 699137b

Please sign in to comment.