NASA-AMMOS / NASA-AMMOS/AIT-Core
Add an adaptation user guide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
Adding documentation for new users that provides a list of stuff necessary for a normal adaptation would be good. Currently new projects have to figure it out on their own or chat with us directly for pointers on where to go.
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 reviewing the AIT-Core project and the normal adaptation process to identify what new projects must do and where documentation currently lives. Done means a user guide lists the necessary adaptation steps and points newcomers to the relevant project resources without requiring direct assistance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100