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

Alphabetically arrange modules in Module docs #1167

Closed
5 tasks
aashna27 opened this issue Jul 13, 2019 · 4 comments · Fixed by #1186
Closed
5 tasks

Alphabetically arrange modules in Module docs #1167

aashna27 opened this issue Jul 13, 2019 · 4 comments · Fixed by #1186

Comments

@aashna27
Copy link

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

To gain a sense of what the issue targets go to MODULES.md , we see the module names are arranged somewhat randomly. So the task is to arrange them to make it visibly easy to search for some specific module doc.

  • 📝 Update the following file

    1. MODULES.md and arrange the module names' list alphabetically.

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

Please show us where to look

https://beta.sequencer.publiclab.org

What's your PublicLab.org username?

This can help us diagnose the issue:

Browser, version, and operating system

Many bugs are related to these -- please help us track it down and reproduce what you're seeing!


Thank you!

Your help makes Public Lab better! We deeply appreciate your helping refine and improve this site.

To learn how to write really great issues, which increases the chances they'll be resolved, see:

https://publiclab.org/wiki/developers#Contributing+for+non-coders

@kirito-k
Copy link

Hey, I am a newcomer. I would love to try it out. Is it already claimed?

@kirito-k
Copy link

Can you please check my pull request and tell me is it correctly implemented? I am a bit confused with the information text while I was putting my PR.

@aashna27
Copy link
Author

Thanks a lot, Great work!!! 😄

@GomathiselviS
Copy link

I am beginner and I wish to work on this.Is this already claimed?

jywarren pushed a commit that referenced this issue Aug 3, 2019
…the corpus (#1186)

* Sorted index and the corpus

* Changed text overlay sequence
jywarren pushed a commit that referenced this issue Dec 16, 2019
…the corpus (#1186)

* Sorted index and the corpus

* Changed text overlay sequence
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants