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.md : WIP #800

Merged
merged 7 commits into from
Jan 15, 2022
Merged

Added CONTRIBUTING.md : WIP #800

merged 7 commits into from
Jan 15, 2022

Conversation

gaurava05
Copy link

Fixes #799

Added the CONTRIBUTING.md file in the repo and linked it inside the newly created "Contributing" section of the README.md

Changes

  • Added a "Contributing" section in the README.md file with the link to the newly created CONTRIBUTING.md file and a link to join our Slack workspace
  • Created a new CONTRIBUTING.md file with the text by @Jaifroid mentioned in Issue Update documentation to include new implementation #792
  • Added instruction to carry out extension version testing in the browser(needs review here @Jaifroid )

Flags

Needs review in the following changes:

  • Testing the extension versions locally (line number 21-23 in CONTRIBUTING.md)
  • Here, I mentioned just for the chrome, how can we cover other platforms too? Also, should we also link instructions to load an extension's source code in the browser
  • Added Slack link in the README.md's contribution section for the ease of newcomers, is it fine?

Related Issues

@Jaifroid Jaifroid self-requested a review January 14, 2022 05:48
@Jaifroid Jaifroid added this to the v3.3 milestone Jan 14, 2022
Copy link
Member

@Jaifroid Jaifroid left a comment

Choose a reason for hiding this comment

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

Thank you for this useful PR. Just some minor changes as suggested in the review comments, please.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@gaurava05
Copy link
Author

@Jaifroid thanks for your useful review. Will make the necessary changes.

@gaurava05
Copy link
Author

@Jaifroid pushed another commit with the required changes. Please review at your convenience.

Copy link
Member

@Jaifroid Jaifroid left a comment

Choose a reason for hiding this comment

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

Thank you, it's looking good now! I'll request a review from Mossroy.

@Jaifroid Jaifroid requested a review from mossroy January 14, 2022 07:32
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Jaifroid added a commit that referenced this pull request Jan 14, 2022
@Jaifroid Jaifroid mentioned this pull request Jan 15, 2022
18 tasks
@mossroy
Copy link
Contributor

mossroy commented Jan 15, 2022

There's a file with the same name in https://github.com/kiwix/overview/blob/master/CONTRIBUTING.md , that covers the basic steps for creating a PR.

I prefer your file, but it might be worth pointing to an external documentation that explains how to create a PR on github

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@Jaifroid Jaifroid left a comment

Choose a reason for hiding this comment

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

Thanks for the latest. All fine for me now!

@Jaifroid
Copy link
Member

@gaurav7019 Thanks for this PR! We can merge it now. Are you ready for me to squash/merge (it will still appear as your PR)?

@gaurava05
Copy link
Author

@gaurav7019 Thanks for this PR! We can merge it now. Are you ready for me to squash/merge (it will still appear as your PR)?

Yeah sure, go ahead. It was a great first experience. 😄

@Jaifroid Jaifroid merged commit 18fe5a2 into kiwix:master Jan 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md to the repo
3 participants