-
Notifications
You must be signed in to change notification settings - Fork 31
fix: update module name to use github url #280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The previous module name was invalid and using a subfolder to store the source code was creating additional burden (e.g. you cannot 'git clone && make'. Update the module name to use the github url and flatten the directory structure.
/test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a couple of comments on the readme. Let me know what you think.
README.md
Outdated
|
||
See [contributing](CONTRIBUTING.md) for details about reporting bugs, requesting features, or code contributions. | ||
|
||
## Testing unreleased versions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of this is developer-oriented, and not relevant to end users. Although we have end-user docs, I think it would still be nice to keep this landing page minimal.
What do you think about moving all of the below with the exception of License and Release to a new TESTING.md doc? License should stay in this doc. And maybe link to RELEASE.md from CONTRIBUTING.md?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I agree, that's a lot cleaner!
And maybe link to RELEASE.md from CONTRIBUTING.md?
I'm not sure about this. Release is already linked in the readme and won't provide much value to contributors as it's not something they would worry about. Maybe we should link to TESTING.md ? WDYT ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, looks good. Just spotted a few typos in the existing docs.
Co-authored-by: Andrew Wilkins <[email protected]>
Co-authored-by: Andrew Wilkins <[email protected]>
/test |
The previous module name was invalid and using a subfolder to
store the source code was creating additional burden (e.g.
you cannot 'git clone && make'.
Update the module name to use the github url and flatten the
directory structure.
Closes #261