Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature]: Add Generic Client Repository README #1

Open
18 tasks
jimbrig opened this issue Jun 1, 2024 · 0 comments
Open
18 tasks

[Feature]: Add Generic Client Repository README #1

jimbrig opened this issue Jun 1, 2024 · 0 comments

Comments

@jimbrig
Copy link
Member

jimbrig commented Jun 1, 2024

Need to templatize this repo's README.md.

Ideally, for a client repository the README would include things such as:

  • "header" with the client logo and name that is centered and has large text
  • badges section
  • TOC
  • Overview
  • Repository Structure
  • Projects (Sub-Modules in src/)
  • Client Brand Assets
  • Documentation
  • Data and Metadata
  • Administrative Documents
  • Communications and Logs
  • Usage Guidelines
  • Team
  • Contact
  • client details:
    • Name, Code Name, Abbreviations, etc.
    • Industry
    • etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
[Internal]: Templates
Status: Todo
[Template] Client Project
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jimbrig