Skip to content
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

Merged
merged 6 commits into from
Sep 27, 2024

Conversation

psankhe28
Copy link
Contributor

Checklist

  • A link to the issue/user story that the pull request relates to
  • How to recreate the problem without the fix
  • Design of the fix
  • How to prove that the fix works
  • Automated tests that prove the fix keeps on working
  • Documentation - any JSDoc, website, or Stackoverflow answers?

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

@psankhe28 psankhe28 requested a review from a team September 12, 2024 17:43
@psankhe28 psankhe28 marked this pull request as draft September 12, 2024 17:43
@psankhe28 psankhe28 marked this pull request as ready for review September 12, 2024 18:55
Copy link
Contributor

@davidkel davidkel left a 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.

docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@davidkel davidkel left a 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

CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
docs/source/getting-started/contributing.md Outdated Show resolved Hide resolved
Signed-off-by: Prati28 <[email protected]>
Copy link
Contributor

@davidkel davidkel left a 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 Show resolved Hide resolved
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.
Copy link
Contributor

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.

Copy link
Contributor Author

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

docs/source/index.md Show resolved Hide resolved
Signed-off-by: Prati28 <[email protected]>
Copy link
Contributor

@davidkel davidkel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@davidkel davidkel merged commit baca4cf into hyperledger-caliper:main Sep 27, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants