Skip to content

Maintain Descriptive and Detailed README #70

@jaARke

Description

@jaARke

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationstretchNo clearly-defined end goal, ongoing consideration

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions