Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.23 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.23 KB

Open Source Force Hackathon v1.0.0

Metadata

Start date: August 1 00:00:00 UTC (tentative)

Project: Some sort of API or CLI tool (subject to change)

Guidelines

  • Your project should have a descriptive README
  • It should be fairly simple to install. We suggest publishing to a public package registry like NPM or PyPI, or compiling a binary and providing an easy download along with the SHA fingerprint. If you provide a binary or minified code, you must include source code as well as instructions to build/compile.
  • ⚠️ In Development ⚠️

Getting Started

Registration

  1. Fork the repo, clone, and run npm i if possible.
  2. Create a file in the projects/ directory named <username>.json. Use your GitHub username.
  3. Follow the JSON schema in project.schema.json to fill out your file. See project.example.json for an example.
  4. Validate your JSON if possible: npm run validate -- projects/<username>.json.
  5. Open a PR.
  6. Follow instructions in the Open Source Force Discord server to confirm your registration.
  7. Wait for merge.