-
-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Overview
The project is missing some crucial documentation, which needs to be updated. Since I'm currently working alone on this project, it might require some extra time to update all the necessary things fully. I've listed the important documentation first for the initial level, followed by others (which may be updated on a later release).
Important Documentation
- Add HOWTO.md - provides general information on how to get started with this template. #4
- Update CONTRIBUTING.md - provide a general contributing template.
Code Related Documentation
- Update
notebooks/BOILERPLATE.ipynb
with directory structure and commands. #3 - May provide a new template file for starting a production level code.
- Provide template for
agents
,engine
andmodels
for any given generic project. - Provide additional
.github
and/or CI/CD functionalities which a user can open based on requirements. - Setup/provide additional branches like
production
,development
, which are required by any project.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request