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.

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

DOC: Add a useful README to the project #372

Closed
WillStrohl opened this issue Jul 13, 2023 · 1 comment · Fixed by #381
Closed

DOC: Add a useful README to the project #372

WillStrohl opened this issue Jul 13, 2023 · 1 comment · Fixed by #381
Assignees
Milestone

Comments

@WillStrohl
Copy link
Member

Description of task

As of right now, there isn't a README associated to this project. This task is for us to consider whether or not to add one, and what it should contain. This is a great opportunity for us to get it as close to being "correct" on the first push. :)

What I'm thinking it should include might be:

  • What is the community forums module?
  • Who is currently maintaining the module?
  • How do you find help for the module?
    -- Persona-Based: developers, end-users, administrators, moderators, etc.
  • How do you help contribute code to this module?

What general area(s)/component(s) are affected?

[] User interface
[] Database schema
[] Business Logic
[] Dependencies
[] Installation/manifest
[x] None of the above

Additional context

Add any other context or screenshots about the task here.

@johnhenley johnhenley added this to the 08.00.00 milestone Jul 13, 2023
@WillStrohl
Copy link
Member Author

Actively working on this.

@johnhenley johnhenley changed the title Add a useful README to the project DOC: Add a useful README to the project Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants