NASA-AMMOS / NASA-AMMOS/AIT-Core
Add log module documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
Add documentation explaining what functionality the log module provides, how it's built with syslog in mind, and provide directions for users to look up configuration options.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Python log module and the repository's existing documentation structure. Explain the module's functionality, its syslog-oriented design, and how users can find configuration options; the documentation is done when all three topics are covered clearly.
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