-
Notifications
You must be signed in to change notification settings - Fork 404
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
added contributing guide #1634
added contributing guide #1634
Conversation
Signed-off-by: Prati28 <[email protected]>
Signed-off-by: Prati28 <[email protected]>
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.
some corrections needed here.
Signed-off-by: Prati28 <[email protected]>
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.
Sorry, some changes required. Also I hadn't realised that the links in the docs in the repo are all absolute links. We need to change them all to be relative links
Signed-off-by: Prati28 <[email protected]>
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.
Just a few minor changes now
CONTRIBUTING.md
Outdated
@@ -7,6 +7,8 @@ This guideline intends to make contribtuions to Caliper easier by: | |||
|
|||
If you have further suggestions about improving the guideline, then you can follow the presented workflow to make your contribution. | |||
|
|||
Jump to [Contributing documentation](./docs/Contributing.md) to get started on your journey. |
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.
This is the wrong link, when I click on it I get a 404 not found. It's docs/source/contributing.md
however I am wondering whether this should link to the md file or whether it should go to the served docs (ie https://hyperledger.github.io/caliper/). For now it works. We should probably change it once we have the new docs published as the served docs presents a nicer view than just the standard md viewer.
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.
Yeah, after deployment I will change the link to the served docs
Signed-off-by: Prati28 <[email protected]>
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.
LGTM
Checklist
Issue/User story
Steps to Reproduce
Existing issues
Design of the fix
Validation of the fix
Automated Tests
What documentation has been provided for this pull request