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

Update README #325

Closed
5 tasks
Somya-Singhal opened this issue Apr 6, 2022 · 7 comments · Fixed by #335
Closed
5 tasks

Update README #325

Somya-Singhal opened this issue Apr 6, 2022 · 7 comments · Fixed by #335

Comments

@Somya-Singhal
Copy link
Contributor

Somya-Singhal commented Apr 6, 2022

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: Claim the issue by commenting. 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!
💡 Learn how to claim 🙋

Claiming an issue

Unless the issue is marked as reserved for someone, you can just say "I'd like to try this!" and then you've claimed it - no need to wait for someone to assign it to you. Just be sure you link your pull request (PR) to this issue so we can see where your solution is.

And open one early if possible - even before you've completed it with additional commits - and others can help you figure out any issues you may face.

  • 📝 Update the file $FILENAME in the $REPO repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Where to look for fixing this issue

infragram/blob/main/README.md

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

+ * Find the steps on how to make a Pull Request at https://github.com/publiclab/infragram/issues/300
  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are not familiar with GitHub or the pull request model, here is a guide you can follow on how GitHub works.

  2. If you are familiar with the terminal or would like to learn to use it, here is a great tutorial on how to send a pull request using the terminal.

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

Before Changes

pl-14

After Changes were made

pl-15

🤔❓ Questions?

Leave a comment below!

@Somya-Singhal
Copy link
Contributor Author

Hello @TildaDares @jywarren, I created a FTO issue to add link to the README file. Can you please review it and suggest the changes if any needed?

@Somya-Singhal Somya-Singhal changed the title Add link to README Update README Apr 6, 2022
@TildaDares
Copy link
Member

@Somya-Singhal This looks really great. I was thinking maybe we could add it under the Developers heading instead https://github.com/publiclab/infragram#developers. What do you think?

@Somya-Singhal
Copy link
Contributor Author

Ya @TildaDares , it will look more organized. I will update the comment.

@Somya-Singhal
Copy link
Contributor Author

I have updated @TildaDares @jywarren, Can you please review it?

@TildaDares
Copy link
Member

Great work @Somya-Singhal. Thank you!!!!

@TildaDares
Copy link
Member

Reserved for @ShrutiKoli19 for 24 hours!!

@ShrutiKoli19
Copy link
Contributor

Thankyou @TildaDares for assigning me the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants