publiclab / infragram

A minimal core of the Infragram.org project in JavaScript
https://infragram.org/sandbox/
GNU General Public License v2.0
46 stars 166 forks source link

Move Contributing Guidelines to Bottom of README #394

Closed TildaDares closed 2 years ago

TildaDares commented 2 years ago

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

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

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

@@ -23,34 +23,6 @@ Read more at https://publiclab.org/infragram
 4. `npm install` - this will install all the node packages into your local machine.
 5. `npm install http-server -g && http-server` (this installs http-server globally and then runs it, next time you just need to do `http-server` to run it locally)

-## Contributing
-
-We welcome contributions and are especially interested in welcoming [first-time contributors](#first-time). Read more about [how to contribute](#developers) below! We especially welcome contributions from people belonging to groups under-represented in free and open-source software!
-
-### Code of Conduct
-
-Please read and abide by our [Code of Conduct](https://publiclab.org/conduct); our community aspires to be a respectful place both during online and in-ยญperson interactions.
-
-
-## Developers
-
-Help improve Public Lab software!
-
-* Join the chatroom at https://publiclab.org/chat
-* Look for open issues at https://github.com/publiclab/infragram/labels/help-wanted
-* We're specifically asking for help with issues labeled with the https://github.com/publiclab/infragram/labels/help%20wanted tag
-* Find lots of info on contributing at http://publiclab.org/developers
-* Review specific contributor guidelines at http://publiclab.org/contributing-to-public-lab-software
-* Find the steps on how to make a Pull Request at https://github.com/publiclab/infragram/issues/300
-
-## First Time?
-
-New to open source/free software? Here is a selection of issues we've made **especially for first-timers**. We're here to help, so just ask if one looks interesting : https://code.publiclab.org
-
-[Here](https://publiclab.org/notes/warren/11-22-2017/use-git-and-github-to-contribute-and-improve-public-lab-software) is a link to our Git workflow.
-
-## Let the code be with you, happy open-sourcing :smile:
-
 ## Purpose

 The purpose of this software is to convert a photo taken from an "Infragram" multispectral camera using NDVI or another technique, then colorize that image. It can then be downloaded or forwarded to another web app.
@@ -192,3 +164,31 @@ See the deprecation label for more on this code: https://github.com/publiclab/in
 ## Pi and VR versions

 Two extra folders `/pi/` and `/vr/` are for different variants of the project, designed to be run on a [Raspberry Pi-based camera](https://publiclab.org/infragram-pi) (live-streaming video through the converter from the Pi camera) and for use with a VR headset with a Pi camera attached to the front. These are experimental but if major breaking changes are implemented in the main `index.html` file, we would like them to be ported over to these files as well, especially the `/pi/` version, so the interfaces look and work the same.
+
+## Contributing
+
+We welcome contributions and are especially interested in welcoming [first-time contributors](#first-time). Read more about [how to contribute](#developers) below! We especially welcome contributions from people belonging to groups under-represented in free and open-source software!
+
+### Code of Conduct
+
+Please read and abide by our [Code of Conduct](https://publiclab.org/conduct); our community aspires to be a respectful place both during online and in-ยญpersoninteractions.
+
+
+## Developers
+
+Help improve Public Lab software!
+
+* Join the chatroom at https://publiclab.org/chat
+* Look for open issues at https://github.com/publiclab/infragram/labels/help-wanted
+* We're specifically asking for help with issues labeled with the https://github.com/publiclab/infragram/labels/help%20wanted tag
+* Find lots of info on contributing at http://publiclab.org/developers
+* Review specific contributor guidelines at http://publiclab.org/contributing-to-public-lab-software
+* Find the steps on how to make a Pull Request at https://github.com/publiclab/infragram/issues/300
+
+## First Time?
+
+New to open source/free software? Here is a selection of issues we've made **especially for first-timers**. We're here to help, so just ask if one looks interesting : https://code.publiclab.org
+
+[Here](https://publiclab.org/notes/warren/11-22-2017/use-git-and-github-to-contribute-and-improve-public-lab-software) is a link to our Git workflow.
+
+Let the code be with you, happy open-sourcing :smile:
  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.

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, and reach out in our chatroom!

TildaDares commented 2 years ago

Reserved for @komal3120 for 24 hours!

komal3120 commented 2 years ago

I am working on it

komal3120 commented 2 years ago

@TildaDares I am done with issue check PR https://github.com/publiclab/infragram/pull/401