ComputerScienceHouse / ComputerScienceHouse/self-service
Better README
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
As the beginning of the year approaches, freshman will soon try to look at and contribute to CSH projects. It's a bit hard when there are no setup instructions, or links of where to download python, pip, or any other tools we use.
It would be a good idea to add to the README some setup and other useful information
- [x] Setup information
- [x] System Dependencies
- [x] Python version, potentially as a badge [](https://www.python.org/downloads/release/python-360/)
- [ ] Code standards (Less important if pylint is present)
Contributor guide
No contributing guide indexed for this repository
Research direction
Update the repository README with setup instructions, system dependencies, download links for Python, pip, and other tools, the Python version or badge, and code standards if applicable. Review the existing README first and use the checklist to confirm the requested information is present and understandable to new contributors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100