AndrewCMonson / oscar

Oscar is an open source personal assistant for solo developers built on OpenAI and integrated with your favorite productivity tools

MIT License

0 stars 0 forks source link

Documentation & Development: Open Source Prep #8

Closed AndrewCMonson closed 3 days ago

AndrewCMonson commented 5 days ago

Summary

The repository needs a number of preparations to prepare for an open source release.

Proposed Solution

Add a number of pieces of documentation to help any open source contributors navigate contributing
Prepare the codebase for easy assembly on local machines for developers to spin up quickly

Benefits

Ease of contribution
Guidelines for open source engagement
Enhanced documentation

Acceptance Criteria

[x] Contribution guidelines developed and added to root directory
[x] Code of conduct created and linked in contribution guidelines
[x] ReadMe created and added to root directory
[x] Scripts placed in root package.json to install dependencies in one yarn command
[x] Bug report template created
[x] Issue creation template created

Notes

N/A

AndrewCMonson commented 3 days ago

completed and closed