Skip to content

Commit

Permalink
Apply common project tweaks (#59)
Browse files Browse the repository at this point in the history
* Sort package.json

* Add 'level' to package keywords

* Update LICENSE.md

* Update License section in README.md

* Update Contributing section in README.md

* Fix repository and homepage in package.json

* Add hallmark and standard
  • Loading branch information
vweevers committed Jan 5, 2019
1 parent 8b3efe1 commit a6aa799
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 29 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## `Level` projects are **OPEN Open Source Projects**
-----------------------------------------

* * *

## What?

Expand All @@ -10,10 +11,10 @@ Individuals making significant and valuable contributions are given commit-acces
There are a few basic ground-rules for contributors:

1. **No `--force` pushes** or modifying the Git history in any way.
1. **Non-master branches** ought to be used for ongoing work.
1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
1. Contributors should attempt to adhere to the prevailing code-style.
2. **Non-master branches** ought to be used for ongoing work.
3. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
4. Internal pull-requests to solicit feedback are _encouraged_ for any other non-trivial contribution but left to the discretion of the contributor.
5. Contributors should attempt to adhere to the prevailing code-style.

## Releases

Expand All @@ -23,4 +24,4 @@ Declaring formal releases remains the prerogative of the project maintainer(s).

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

-----------------------------------------
* * *
21 changes: 21 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributors

| Name | GitHub | Social |
| :------------------- | :----------------------------------------------------- | :------------------------------------------------------------------ |
| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) |
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |
| **Huan LI** | [**@zixia**](https://github.com/zixia) | [**@zixia@twitter**](https://twitter.com/zixia) |
| **Anton Whalley** | [**@no9**](https://github.com/no9) | [**@dhigit9@twitter**](https://twitter.com/dhigit9) |
| **Jake Verbaten** | [**@Raynos**](https://github.com/Raynos) | [**@raynos@twitter**](https://twitter.com/raynos) |
| **Joseph Dykstra** | [**@ArtskydJ**](https://github.com/ArtskydJ) | |
| **Oguz Bastemur** | [**@obastemur**](https://github.com/obastemur) | [**@obastemur@twitter**](https://twitter.com/obastemur) |
| **Mathias Buus** | [**@mafintosh**](https://github.com/mafintosh) | [**@mafintosh@twitter**](https://twitter.com/mafintosh) |
| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) |
| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | [**@dominictarr@twitter**](https://twitter.com/dominictarr) |
| **Jarrett Cruger** | [**@jcrugzz**](https://github.com/jcrugzz) | [**@jcrugzz@twitter**](https://twitter.com/jcrugzz) |
| **Paolo Fragomeni** | [**@hxoht**](https://github.com/hxoht) | [**@hxoht@twitter**](https://twitter.com/hxoht) |
| **j chesley** | [**@chesles**](https://github.com/chesles) | [**@chesles@twitter**](https://twitter.com/chesles) |
| **Pedro Teixeira** | [**@pgte**](https://github.com/pgte) | [**@pgte@twitter**](https://twitter.com/pgte) |
| **David Björklund** | [**@kesla**](https://github.com/kesla) | [**@david_bjorklund@twitter**](https://twitter.com/david_bjorklund) |
| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) |
| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) |
26 changes: 17 additions & 9 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
The MIT License (MIT)
=====================
# The MIT License (MIT)

Copyright (c) 2012-2015 `Level` contributors
---------------------------------------
**Copyright © 2012-present [Contributors](CONTRIBUTORS.md).**

*`Level` contributors listed at <https://github.com/level/community#contributors>*
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,14 @@ console.log(JSON.stringify(contributors, null, 2))

## Contributing

`Level` projects are **OPEN Open Source Projects**. This means that:
[`Level/community`](https://github.com/Level/community) is an **OPEN Open Source Project**. This means that:

> Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.
> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
See the [`CONTRIBUTING.md`](https://github.com/level/community/blob/master/CONTRIBUTING.md) file for more details.
See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

## License

Copyright &copy; 2012-present `Level` contributors.

`Level` projects are licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included [`LICENSE.md`](https://github.com/level/community/blob/master/LICENSE.md) file for more details.
[MIT](LICENSE.md) © 2012-present [Contributors](CONTRIBUTORS.md).

[level-badge]: http://leveldb.org/img/badge.svg
27 changes: 19 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,30 @@
{
"name": "level-community",
"description": "Meta data on members of the LevelDB community",
"version": "3.0.0",
"description": "Meta data on members of the LevelDB community",
"license": "MIT",
"main": "index.js",
"scripts": {
"test": "standard && hallmark",
"hallmark": "hallmark --fix"
},
"dependencies": {},
"devDependencies": {
"hallmark": "^0.1.0",
"standard": "^12.0.1"
},
"hallmark": {
"community": "."
},
"repository": {
"type": "git",
"url": "https://github.com/level/community.git"
"url": "https://github.com/Level/community.git"
},
"homepage": "https://github.com/level/community",
"homepage": "https://github.com/Level/community",
"keywords": [
"level",
"leveldb",
"community",
"npm"
],
"main": "index.js",
"dependencies": {},
"devDependencies": {},
"license": "MIT"
]
}

0 comments on commit a6aa799

Please sign in to comment.