Lucy-Forrest-Lab / Lucy-Forrest-Lab/hm_analysis_tool
review
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Nice job with this Vanessa. A very nice start to your journey becoming a bona fide pythonista.
As you move forward with this or other projects in the future I was say a little more help to the random visiter with some more documentation would be useful. Additionally, have a look into entry points in setup.py. They allow you to have executables on your path upon installation. For example, the entry point get_molpdf would be a command people can run. Under the hood it would call the main function in the get_molpdf.py file (or whatever you choose to run for that "program").
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 reading setup.py and get_molpdf.py to understand the current package layout and main entry point. Clarify which documentation should be added for visitors and what executable behavior is expected; done means the requested documentation exists and the get_molpdf command is available after installation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100