legaldb
legaldb copied to clipboard
creativecommons
[Feature] Improve Documentation
Problem
Although, its obvious yet I would suggest adding a git clone command for users trying to setup locally in the documentation.
Description
Adding a clone command in Readme.md would be a little more convenient for new developers to setup local environment.
I wish to add the following lines to the documentation:
"To clone this repo, type the following command in your terminal:
git clone https://github.com/creativecommons/legaldb.git"
Implementation
- [x] I would be interested in implementing this feature.
For this kind of basic dependency, I think we should link to authoritative resources instead of copying portions of them.
For this kind of basic dependency, I think we should link to authoritative resources instead of copying portions of them.
Hey @TimidRobot ,
I didn't catch what you meant exactly by link to authoritative resources. Could you please give an example or explain a little?
For example, instead of providing instructions on cloning, etc., a repository from GitHub, we should link to GitHub's beginner documentation. I imagine a Development Dependencies section with a short list of links.
I am willing to work on this issue can you please assign it to me @TimidRobot
Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs (we generally don't assign issues prior to resolution).
I have read it but not able to get what you want to say about assigning this issue to me @TimidRobot
@BalrajDhakad Instead of asking for issues to be assigned, do the work and submit a pull request (PR). Even if multiple people submit PRs for the same issue, they can all list their own PRs on their application. It is the quality of work that is important, not whether it is merged.
