LBRYCommunity/lbry-desktop

Fork 0

Outdated CONTRIBUTING File #4166

New issue

Closed

opened 2020-05-10 14:16:02 +02:00 by harshkhandeparkar · 6 comments

harshkhandeparkar commented

2020-05-10 14:16:02 +02:00

(Migrated from github.com)

First Timers Only

This issue is reserved for people who haven't contributed to our codebase before, or never contributed to Open Source. About First Timers Only.

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

What is to be done?

The CONTRIBUTING.md file, that has instructions/guidelines for new contributors, was written a long time ago and some sections are a little outdated.
For example, the file refers to src/ directory which no longer exists.

You'll have to:

Check for broken links and old references.
Wrong instructions.
Fix em!

🔎 Files To Look Into:

= CONTRIBUTING.md

📋 Step by Step

📜 Read The CONTRIBUTING File: We welcome contributions from everyone, the CONTRIBUTING will help you get started.

NOTE: Useful links:

- Git Commands
- Installation Instructions
Fork This Repository: A fork is a copy of this repository that is stored under your github account. A fork can be used to test out changes separately and then request to add those to the main repository as well!
🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
Create A New Branch: A branch is used to test new changes before they are merged with the stable master branch. You can create a new branch in the terminal. Make sure to name it descriptively!
📝 Make The Requested Changes
✅ Commit Your Changes: A Git commit is a change that is finalized and recorded in the branch.
🔀 Start a Pull Request(PR). There are two ways how you can start a pull request:

If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.
You can also open a PR from the browser.

🏁 Done Ask in comments for a review :)

Please keep us updated

💬 🔔 - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need it if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below!

### First Timers Only This issue is reserved for people who haven't contributed to our codebase before, or never contributed to Open Source. [About First Timers Only](https://www.firsttimersonly.com/). We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝 If you have contributed before, **consider leaving this one for someone new** and looking through our general [help wanted](https://github.com/lbryio/lbry-desktop/labels/help%20wanted) issues. Thanks! ### 🤔 What you will need to know. Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process. ### What is to be done? The CONTRIBUTING.md file, that has instructions/guidelines for new contributors, was written a long time ago and some sections are a little outdated. For example, the file refers to `src/` directory which no longer exists. You'll have to: - Check for broken links and old references. - Wrong instructions. - Fix em! #### :mag_right: Files To Look Into:  = [CONTRIBUTING.md](https://github.com/lbryio/lbry-desktop/blob/master/CONTRIBUTING.md) ### 📋 Step by Step - [ ] :scroll: **Read The CONTRIBUTING File**: We welcome contributions from everyone, the [CONTRIBUTING](https://github.com/lbryio/lbry-desktop/blob/master/CONTRIBUTING.md) will help you get started. **NOTE**: Useful links: - - [Git Commands](https://www.siteground.com/tutorials/git/commands/) - - [Installation Instructions](https://github.com/lbryio/lbry-desktop#running-from-source) - [ ] **Fork This Repository**: A [fork](https://help.github.com/articles/fork-a-repo/) is a copy of this repository that is stored under your github account. A fork can be used to test out changes separately and then request to add those to the main repository as well! - [ ] :raising_hand: **Claim this issue**: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along! - [ ] **Create A New Branch**: A [branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches) is used to test new changes before they are merged with the stable `master` branch. You can create a new branch in the terminal. Make sure to name it descriptively! - [ ] :memo: **Make The Requested Changes** - [ ] :white_check_mark: **Commit Your Changes**: A Git [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#about-commits) is a change that is finalized and recorded in the branch. - [ ] :twisted_rightwards_arrows: **Start a Pull Request(PR)**. There are two ways how you can start a pull request: 1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal. 2. You can also [open a PR from the browser](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). - [ ] 🏁 **Done** Ask in comments for a review :) ### Please keep us updated :speech_balloon: :bell: - We encourage contributors to be respectful to the community and provide an update **within a week** of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need it if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance! If this happens to you, don't sweat it! Grab another open issue. ### Is someone else already working on this? 🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it. 👥- **If someone seems stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://github.com/lbryio/lbry-desktop/labels/help%20wanted). Thanks! ### 🤔❓ Questions? Leave a comment below!

imanishbarnwal commented

2020-05-11 08:45:26 +02:00

(Migrated from github.com)

Hello, @HarshKhandeparkar I want to take this issue I am new in this open-source community. But I just doubt like will remove all the broken links but after removing it from which link I have to update it means where do I get working links. Thank You!

harshkhandeparkar commented

2020-05-11 08:48:38 +02:00

(Migrated from github.com)

We are not sure whether there are broken links. Besides, you can always ask
here in the chat. We are eveready to help you. Welcome to the community!
Please go ahead and work on this. Thank you.

On Mon, 11 May, 2020, 12:15 PM Manish Kumar Barnwal, <
notifications@github.com> wrote:

Hello, @HarshKhandeparkar https://github.com/HarshKhandeparkar I want
to take this issue I am new in this open-source community. But I just doubt
like will remove all the broken links but after removing it from which link
I have to update it means where do I get working links. Thank You!

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/lbryio/lbry-desktop/issues/4166#issuecomment-626505141,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AIJI5H424HBOJITXOMQQIVDRQ6NJJANCNFSM4M5HB5FA
.

We are not sure whether there are broken links. Besides, you can always ask here in the chat. We are eveready to help you. Welcome to the community! Please go ahead and work on this. Thank you. On Mon, 11 May, 2020, 12:15 PM Manish Kumar Barnwal, < notifications@github.com> wrote: > Hello, @HarshKhandeparkar <https://github.com/HarshKhandeparkar> I want > to take this issue I am new in this open-source community. But I just doubt > like will remove all the broken links but after removing it from which link > I have to update it means where do I get working links. Thank You! > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://github.com/lbryio/lbry-desktop/issues/4166#issuecomment-626505141>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AIJI5H424HBOJITXOMQQIVDRQ6NJJANCNFSM4M5HB5FA> > . >

imanishbarnwal commented

2020-05-11 08:55:22 +02:00

(Migrated from github.com)

Okay, I just need to update them with new links. If stuck somewhere will definitely comment here. Can you assign this to me? Thank You.

We are not sure whether there are broken links. Besides, you can always ask here in the chat. We are eveready to help you. Welcome to the community! Please go ahead and work on this. Thank you.
…
On Mon, 11 May, 2020, 12:15 PM Manish Kumar Barnwal, < @.***> wrote: Hello, @HarshKhandeparkar https://github.com/HarshKhandeparkar I want to take this issue I am new in this open-source community. But I just doubt like will remove all the broken links but after removing it from which link I have to update it means where do I get working links. Thank You! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4166 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AIJI5H424HBOJITXOMQQIVDRQ6NJJANCNFSM4M5HB5FA .

Okay, I just need to update them with new links. If stuck somewhere will definitely comment here. Can you assign this to me? Thank You. > We are not sure whether there are broken links. Besides, you can always ask here in the chat. We are eveready to help you. Welcome to the community! Please go ahead and work on this. Thank you. > […](#) > On Mon, 11 May, 2020, 12:15 PM Manish Kumar Barnwal, < ***@***.***> wrote: Hello, @HarshKhandeparkar <https://github.com/HarshKhandeparkar> I want to take this issue I am new in this open-source community. But I just doubt like will remove all the broken links but after removing it from which link I have to update it means where do I get working links. Thank You! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <[#4166 (comment)](https://github.com/lbryio/lbry-desktop/issues/4166#issuecomment-626505141)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIJI5H424HBOJITXOMQQIVDRQ6NJJANCNFSM4M5HB5FA> .

imanishbarnwal commented

2020-05-11 12:56:00 +02:00

(Migrated from github.com)

I am not able to merge my PR it shows # merging is blocked. Can you help in this? @HarshKhandeparkar

harshkhandeparkar commented

2020-05-11 12:58:09 +02:00

(Migrated from github.com)

Your PR will be merged by a maintainer after reviewing.

On Mon, 11 May, 2020, 4:26 PM Manish Kumar Barnwal, <
notifications@github.com> wrote:

I am not able to merge my PR it shows # merging is blocked. Can you help
in this? @HarshKhandeparkar https://github.com/HarshKhandeparkar

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/lbryio/lbry-desktop/issues/4166#issuecomment-626630759,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AIJI5HZT2XQEF7KPN3RQADTRQ7KU3ANCNFSM4M5HB5FA
.

Your PR will be merged by a maintainer after reviewing. On Mon, 11 May, 2020, 4:26 PM Manish Kumar Barnwal, < notifications@github.com> wrote: > I am not able to merge my PR it shows # merging is blocked. Can you help > in this? @HarshKhandeparkar <https://github.com/HarshKhandeparkar> > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://github.com/lbryio/lbry-desktop/issues/4166#issuecomment-626630759>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AIJI5HZT2XQEF7KPN3RQADTRQ7KU3ANCNFSM4M5HB5FA> > . >

👍 1

harshkhandeparkar commented

2020-05-11 16:01:50 +02:00

(Migrated from github.com)

Fixed via #4171