leanprover-community / leanprover-community/physlib
Improving on-boarding documentation
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 749
- Forks
- 189
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
This is to track progress in the direction of on-boarding documentation. It is being discussed on the Lean Zulip here. Some possible directions:
- Improve the getting started page: https://physlean.com/GettingStarted with information regarding GitHub forking etc.
- Update the contributing file in the main PhysLean repository, to include the key information needed to contribute to the project.
- Create a frequently asked questions page concerning basic questions within the project.
Feel suggest other points here, or assign yourself to any points. Long-form discussions or questions should be made on the Zulip.
Contributor guide
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 with the linked Zulip discussion, then review the GettingStarted page and the contributing file in the main PhysLean repository. Choose an agreed onboarding direction among the getting-started updates, contribution guidance, or FAQ, and confirm the selected documentation fully covers the agreed scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100