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

Maintain Descriptive and Detailed README #70

Open
jaARke opened this issue Mar 14, 2022 · 0 comments
Open

Maintain Descriptive and Detailed README #70

jaARke opened this issue Mar 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation stretch No clearly-defined end goal, ongoing consideration

Comments

@jaARke
Copy link
Collaborator

jaARke commented Mar 14, 2022

For a project that is made to be cycled between different teams, it is important that we keep our README up-to-date. It should thoroughly explain the project's structure, and outline the development workflow. Anything that may not be immediately obvious to another developer down the line should be stated in the README.

Upon completing a task or resolving an issue, take a minute to consider what should be added to the README in regard to that bit of work. In general, something should be added or edited for every major task we complete. Either make these changes yourself or, if you aren't comfortable, contact a project admin with an outline of what you did. Performing this bit of maintenance will make future development much easier.

If you believe the README is in need of some specific update, post your ideas as a comment to this issue.

@jaARke jaARke added documentation Improvements or additions to documentation stretch No clearly-defined end goal, ongoing consideration labels Mar 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stretch No clearly-defined end goal, ongoing consideration
Projects
None yet
Development

No branches or pull requests

1 participant