dssg / dssg/after-hours

Repo Cleanup

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
2
Forks
3
PR merge metrics
No merged PRs in 30d

Description

### Directory Structure
- [ ] Clean, Well named set of directories. Examples include `webapp`, `database`, and `models`.
- [ ] No random files in the root.
- [ ] Explanation of each directory in README.
- [ ] Sub-README's in appropriate folders
- [ ] No directories named after DSSG specific info (ie, person names)
- [ ] Should your team have more than one project, each should have it its own repo.
- [ ] In your `data` or `database` folder, provide a way to re-create your database from scratch. `.sql` files are often appropriate for this.
### README
- [ ] Links to appropriate sections in wiki. See wiki issue for more info.
- [ ] Answers: What have you built? In a few sentences.
- [ ] Answers: How do you install it?
- [ ] Answers: What needs to be done/How can I help?
- [ ] Has some sort of Contact Info
- [ ] Open source license
- [ ] Future Issues opened.
### Config
- [ ] No public facing config info - Make sure never to hardcode in database url, password, etc.
- [ ] Description of how you hide config info, ie yaml, environment variables, etc
- [ ] config.example files
- [ ] Requirements.txt or similar file.
- [ ] Relative links in any html.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by auditing the repository root, its directory structure, README files, data or database folder, configuration files, requirements.txt or similar, and HTML links. Done means the checklist is satisfied: directories and README documentation are organized, database recreation is described, configuration secrets are excluded, example config is present, and required links are relative.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.