codewithnick / codewithnick/py-tic-tac-toe-incom
Update the documentation
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
**This is a small initiative taken by me to promote FOSS**
## This issue is only for first time contributors , to understand how basic contributions work on github
# The documentation should include
- What is the code about
- How to clone it
- How to run the code
If you have never contibuted to github and never made a Documentation these below links will be useful to you
- https://docs.github.com/en/github/getting-started-with-github
- https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests
- https://docs.github.com/en/github/using-git
- https://docs.github.com/en/github/writing-on-github/about-writing-and-formatting-on-github
- https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax
_any small contibutions will be accepted_
- [ ] I have never contributed before to github
- [ ] I have cloned the code locally
- [ ] I have run the code locally
- [ ] I have updated the Readme file upto my best knowledge
Contributor guide
No contributing guide indexed for this repository
Research direction
Clone the repository and read the existing README and project files to understand what the code does and how it runs. Run the code locally, then update the README with an overview, cloning instructions, and steps to run it. The work is done when those sections are accurate and the listed local run steps have been verified.
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
- 45/100