https://github.com/alexcoder04/howto-setup-oss-project

Checklist for setting up an open source project
https://github.com/alexcoder04/howto-setup-oss-project

Last synced: 5 months ago
JSON representation

Checklist for setting up an open source project

• Host: GitHub
• URL: https://github.com/alexcoder04/howto-setup-oss-project
• Owner: alexcoder04
• License: cc0-1.0
• Created: 2022-05-29T20:11:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-06T16:49:00.000Z (over 3 years ago)
• Last Synced: 2025-07-12T02:56:18.023Z (6 months ago)
• Homepage:
• Size: 6.84 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Checklist for Setting up an Open Source Project on GitHub

Not all of these steps are necessary, this is just what I generally do :)

## Readme

 - Installation instructions

 - Usage

 - Configuration

 - Badges (https://shields.io/, https://badgen.net/)

## GitHub project

 - Specify Github topics

 - Code of Conduct

 - Contributing guidelines

## Documentation

 - Wiki

 - Github pages

 - "Man" page

## Building / Automation

 - Makefile

 - Dependabot / code quality checking

## Publishing

 - Github release

 - AUR