NASA-AMMOS / NASA-AMMOS/slim

[New Process Improvement Need]: Software Repository Hygiene

Open
#111 6 comments 0 reactions 1 assignee View on GitHub

@riverma is already working on this.

Since Oct 2, 2023.

governance high complexity more requested
Dominant language
JavaScript
Stars
36
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes - I've already checked

Category

Governance

Describe the need

Once a software project gets rolling, there are aspects important to maintaining the software repository that can aid the health and maintenance of the project. What we need is a clear set of guidelines / checklists for project maintainers to be cognizant of at a recurring interval - to ensure the software repository is following best practices.

Some ideas on hygiene topics:

  • If the project hasn't been updated in a year or more, it should consider being archived and / or deprecated.
  • Responding to pull requests in a timely fashion. Contributors are much less likely to consider helping your project if their pull requests stay ignored for months.
  • Responding to issue ticket conversations / triaging tickets in a timely fashion, including ensuring issue tickets are properly labeled and have assigned projects / milestones / etc. Same reason as above.
  • Responding to discussions in a timely fashion. Same reason as above.
  • Ensuring issue tickets are properly labeled and have assigned projects / milestones / etc.
  • Cleaning out old / merged branches. A giant list of branches can be very confusing to contributors.
  • Ensuring documentation / README has been updated as the software evolves.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.