https://github.com/code4clouds/osscheklist
A checklist of items to have in your Open Source Software Project
https://github.com/code4clouds/osscheklist
Last synced: 5 months ago
JSON representation
A checklist of items to have in your Open Source Software Project
- Host: GitHub
- URL: https://github.com/code4clouds/osscheklist
- Owner: code4clouds
- License: mit
- Created: 2018-01-10T15:40:31.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-12T16:50:40.000Z (over 8 years ago)
- Last Synced: 2025-06-29T09:38:57.131Z (12 months ago)
- Homepage:
- Size: 2.93 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open Source Project Checklist
A checklist to guide your in the creation of your Open Source Project
# Glance
* [ ] Name - Use a simple and a representative name for the project.
* [ ] Definition - If you use a complex name, at least have a good definition of what the project does.
* [ ] Problem - What are you trying to solve with your project.
* [ ] License - Pick a license that will attract people to encourage sharing.
# User Experience
## Reduce steep learning curves
* [ ] Background Information - What do I need to know to use and understand the project.
* [ ] List Prerequisites - What things are needed to use the code.
## Provide value-added documentation
### Provide a starting point
* [ ] How to get the source - High School and College students will appreciate some guidance.
* [ ] How the code is layout - Describe the structure of the project directories.
### Provide a contribution roadmap
* [ ] How to setup the build system
* [ ] How to run the build (and run unit tests)
* [ ] How to contribute
* [ ] How to merge and do pull requests (e.g. add pull request template)
## Simplify the software installation
* [ ] Scripts - To start and build the project.
* [ ] Docker Image - To help users of the code.
* [ ] Add Dependencies - Include everything explicitly need to use the code.
## Provide stable code base
* [ ] Versioning - Releases use this.
* [ ] Tags - Production environment use these.
* [ ] Tests - Help users find at least the simples mistakes before a commit happens.
* [ ] Changelogs - Help users understand if it worth moving to the next version.
* [ ] PR Automated Tests - Help contributors find problems before the reviews do and save time.
# Project Planning
## Plan for success
* [ ] Schedule releases - Show users the project is alive and thriving.
* [ ] Use release versions - Show users whats next to come in the future.
## Prioritization
* [ ] Create roadmaps - Bring everyone together as to what will be important to work on in the future.
* [ ] Create goals - Provide information on what to look forward to the project.
# Recognition
## Create a community
* [ ] Recognize efforts - Welcome and give thanks to contributors e.g. (e.g. add committers file)
* [ ] Use social media to help show the project progress and announce achievements - It helps show people your project is alive.
* [ ] Try to bring the team together - Create meet-ups and help create a community.
* [ ] Allow community members grow in the project - Promote good commiters to reviewers.