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

Display Docs Links for Modules in the UI #1390

Closed
HarshKhandeparkar opened this issue Dec 24, 2019 · 9 comments · Fixed by sanjana091001/image-sequencer#1 or #1506
Closed

Display Docs Links for Modules in the UI #1390

HarshKhandeparkar opened this issue Dec 24, 2019 · 9 comments · Fixed by sanjana091001/image-sequencer#1 or #1506
Assignees

Comments

@HarshKhandeparkar
Copy link
Member

@HarshKhandeparkar HarshKhandeparkar commented Dec 24, 2019

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open-source software!

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 is to be done?

Every module of IS is documented in the docs/MODULES.md file and every module's info.json file contains a link to the docs page.
e.g.:

"docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#edge-detect-module"

You will have to add an HTML <a> link in the module UI which links to the docs, for every module. You can add the link wherever you feel it will look good.

🤔 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.

📋 Step by Step

  • 🙋 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!

  • 📝 Modify the file defaultHtmlStepUi.js

  • 💾 Commit your changes

  • 🔀 Start a Pull Request. 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 on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • 🏁 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!

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 24, 2019

@robwe30

This comment has been minimized.

Copy link

@robwe30 robwe30 commented Dec 26, 2019

I would like to do that, even tho i never really did something on github before.

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 26, 2019

Absolutely! Welcome! This issue is meant to teach you GitHub. You can ask us anything. We will happily answer every question. Please do claim this issue and start work on it.

@robwe30

This comment has been minimized.

Copy link

@robwe30 robwe30 commented Dec 26, 2019

Absolutely! Welcome! This issue is meant to teach you GitHub. You can ask us anything. We will happily answer every question. Please do claim this issue and start work on it.

How do I claim?

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Dec 26, 2019

Just leave a comment here(So that everyone knows that you are working on the issue). We don't want multiple people working on the issue which would lead to a lot of confusion. Please go ahead.

@sanjana091001

This comment has been minimized.

Copy link

@sanjana091001 sanjana091001 commented Jan 7, 2020

Hey,
Can I work on this?

@HarshKhandeparkar

This comment has been minimized.

Copy link
Member Author

@HarshKhandeparkar HarshKhandeparkar commented Jan 7, 2020

You can if @robwe30 is no longer working on it. Or if they agree to let you claim the issue.

@robwe30

This comment has been minimized.

Copy link

@robwe30 robwe30 commented Jan 7, 2020

I am really sorry I don't have time atm. So please let somebody else do that. Sorry.

@harshithpabbati

This comment has been minimized.

Copy link
Member

@harshithpabbati harshithpabbati commented Jan 7, 2020

@sanjana091001 you can work on this issue. Assigning this to you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.