https://github.com/orbitdb/repo-template
A template for creating new repositories in the @orbitdb organization
https://github.com/orbitdb/repo-template
docs documentation example orbitdb template
Last synced: 7 months ago
JSON representation
A template for creating new repositories in the @orbitdb organization
- Host: GitHub
- URL: https://github.com/orbitdb/repo-template
- Owner: orbitdb
- License: mit
- Created: 2018-08-29T13:14:39.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-05-07T14:54:09.000Z (over 4 years ago)
- Last Synced: 2024-12-31T12:26:23.237Z (about 1 year ago)
- Topics: docs, documentation, example, orbitdb, template
- Homepage:
- Size: 12.7 KB
- Stars: 24
- Watchers: 4
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Repo Template
[](https://gitter.im/orbitdb/Lobby) [](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io)
> A template for creating new repositories in the @orbitdb organization
This repository is meant to serve as a general template for how to set up new repositories in the @orbitdb organization. In general, setting up a new repository should take only a few minutes; use this repository as a way of finding example files, and use the following checklist to ensure that you've set up the repository correctly.
## Install
These instructions are basic; you can use any method to do this work. The important part is making sure that you follow the checklist below before publishing the repository.
```sh
# Let's make a new folder
mkdir new-repo && cd new-repo
# Start a Git instance and copy over template files.
git init
cp ../repo-template/* .
# Overwrite this README
mv README.md setup-checklist.md
mv example-README.md README.md
# Go over and check off the checklist, and finally
rm setup-checklist
```
## Checklist
Go through this checklist after creating your repository. It should only take a couple of minutes; if there is a way to make this more efficient, open an issue and let's talk about it here! \m/
### README
- [ ] Copy `example-README.md` from this repository to your directory.
- [ ] Rename all instances of `` in README to match the new repo title
- [ ] Manually go through and edit the rest of the README.
### Other Files
- [ ] Copy `CODE_OF_CONDUCT.md` verbatim.
- [ ] Copy `CONTRIBUTING.md` and ensure that you've added any repository-specific instructions. (Replace `` again).
- [ ] Should you have a `CHANGELOG.md`? Document your release process, if you plan on having one, in the `CONTRIBUTING.md` file.
### Dotfiles
- [ ] Do you need a `.gitignore` file?
- [ ] Do you need an `.npmignore` file?
### License
- [ ] Copy the MIT license from the example repo.
- [ ] Is `Haja Networks Oy` the licensor?
- [ ] Have you added `MIT` as the license in the `package.json`?
- [ ] If you made changes, were these reflected in the last section of the README?
### GitHub Metadata
- [ ] Have you added a short description to the repository?
- [ ] Is the description matched in the byline under the title in the README?
- [ ] Have you added topics to the GitHub repository: `orbitdb`, `orbit`, and so on?
- [ ] Have you added these topics as keywords in the `package.json`?
### `package.json`
- [ ] Is the `author` field correct?
- [ ] Have you added `keywords`?
- [ ] Are the `bugs` and `homepage` fields correct?
- [ ] Have you added tests? Are they matched, here?
- [ ] Have you added a `lint` command, if using [`eslint-config-orbitdb`](https://github.com/orbitdb/eslint-config-orbitdb)?
### Tests
- [ ] Are there automated tests?
- [ ] ...for the browser as well?
- [ ] Are those reflected in CI?
- [ ] Bonus points: Using CircleCI workflows to segment tests?
- [ ] Extra bonus points: Are you cross-testing dependencies (i.e. are changes in `orbit-db-keystore` tested in `orbit-db` as well
### Benchmarks
- [ ] Are there benchmarks?
- [ ] Did you run the benchmarks before / after the change or PR?
### Examples
- [ ] Is there an example folder with usage examples?
- [ ] For the browser as well?
## Contribute
If you think this could be better, please [open an issue](https://github.com/orbitdb/repo-template/issues/new)!
Please note that all interactions in [@OrbitDB](https://github.com/orbitdb) fall under our [Code of Conduct](CODE_OF_CONDUCT.md).
## License
[MIT](LICENSE) © 2018 Haja Networks Oy