[Public Lab software](#Projects), including this website, is written collaboratively by a community of contributors. _Above: a diagram of the various [Public Lab software projects]( **We're so happy to meet you! This page is to welcome new contributors.** We especially welcome contributions from people from **groups under-represented** in free and open source software! Our community aspires to be a respectful place. Please read and abide by our [Code of Conduct](/conduct). ## How to contribute **We are actively seeking contributors**, so please **[visit our welcome page](** and ask about how you can help keep these free and open source software projects working (and improving) for our thousands of community members! ### First-timers only If this is your first time, **welcome**! We're so happy to meet you! This page is to welcome new contributors looking to get involved in coding with Public Lab. We especially welcome contributions from people from groups *underrepresented in free and open source software!* Please see [our welcome page]( If you'd like to quickly jump into an issue, see the following list for any available [first-timers-only issues]( Read more about our [software outreach work here](/software-outreach)! **** ## Activities [activities:software] **** ## Questions [questions:software] **** ## Projects For an in-depth overview of all PL software projects, see Project Description Source Code Ruby on Rails This very website! - a collaborative knowledge-exchange platform. github:publiclab/plots2 MapKnitter Ruby on Rails Assemble aerial images into maps. github:publiclab/mapknitter Spectral Workbench Ruby on Rails Material analysis using DIY spectrometry. JavaScript core on GitHub github:spectral-workbench PublicLab.Editor JavaScript A general purpose, JS/Bootstrap UI framework for rich text posting, with an author-friendly, minimal, mobile/desktop interface. github:publiclab/PublicLab.Editor Leaflet.DistortableImage JavaScript Leaflet plugin built for MapKnitter. Enables images to be distorted. github:publiclab/Leaflet.DistortableImage Leaflet.BlurredLocation JavaScript A Leaflet-based interface for selecting a "blurred" or low-resolution location, to preserve privacy github:publiclab/leaflet-blurred-location WebJack JavaScript a JavaScript library that uses an audio software modem to communicate with an Arduino via a headphone jack github:publiclab/webjack ImageSequencer JavaScript/Node.js Prototype sequential image processing system, inspired by storyboards github:publiclab/image-sequencer Infragram JavaScript Analyze plant health with infrared imagery. github:publiclab/infragram Public Lab is on Github at: ## First time contributors New to open source/free software? Here are some resources to get you started: Our welcome page for newcomers looking to get involved in coding: ### Resources #### Getting started * * A very in-depth guide: * #### Setup * Lots on Ruby, Rails, databases and more: #### Pull requests * * the basic GitHub Flow workflow: #### Git * Rebasing step by step: * guidance on rebasing: * revert a single file to a specific revision in Git: * @warren: I've found if I get in real trouble rebasing, sometimes I'll try to squash my feature branch commits /without rebasing/ before then rebasing just one commit: **** ### Contributing for non-coders Not interested (or not yet interested) in coding, but still want to help out? Have a project you really need to get your work done, and trying to encourage coders to tackle it? You can still help out; in fact, **helping to clearly describe and document problems and new feature proposals is at least as important as writing the code itself**. When creating or editing an issue, try to: 1. Clearly describe the problem, linking to pages where it can be observed, or where a new feature might live. Include screenshots to be very specific! 2. (for bugs) If you don't know the problem, do what you can to help others narrow it down: provide contextual information like your browser, OS, and what you were doing when it happened. Did it used to work? Does it still, but only sometimes? Help them reproduce it! 3. Propose a solution. Whether or not you code, describing what **should** or **could** happen, or even what you expected to happen is always helpful to someone looking to fix it. This can be as simple as "It should show a notification." or "There should be a way to hide it." Once an issue is well documented, we can tag it with `help-wanted` to get the word out that we're looking for someone to try to fix it. If you're not sure if it's ready, ask [on the plots-dev list](#Sign+up) Finally, if your issue is well documented, try to get involved in some outreach to new contributors to match someone with the project! Tell them what it'll help you achieve and why you'd appreciate help. And coordinate with the [plots-dev discussion list](#Sign+up) to get the word out. **** ### Preparing issues for newcomers Related to the above, even if you are a coder, we need help "rolling out the red carpet" (as the [Hoodie project]( calls it) for new contributors, to grow our contributor base. The steps in [Contributing for non-coders](#Contributing+for+non-coders) are a good starting point, but as a coder, you can also deep-link to the relevant lines of code, with Github links and pointers like: > Then, the keyword `:medium` in JavaScript on this line must be changed to `:large` too: -- does that make sense to you? This is especially great for attracting coders who are not only new to our code but new to coding in general! Learn more about [how to make a good `first-timers-only` issue here](/notes/warren/10-31-2016/create-a-welcoming-first-timers-only-issue-to-invite-new-software-contributors). **** ## Reviewers Mentoring for [Summer of Code programs](/gsoc) has a lot in common with being a software "reviewer" with Public Lab throughout the year; to welcome and support our community of coders, we need to: * always be kind and respectful! (remember our [Code of Conduct!](/conduct)) * help people to become better coders and don't make them feel bad * encourage people to open a PR with their work even if it's not finished * go through recent PRs to help people who are stuck * use emojis! Some specific things you can do: * add links to relevant lines of code to help people see where to start, or for an example of a similar feature * suggest writing a test to *protect your work* from future issues * tag things as `break-me-up` if it's possible to do a project in separate simpler parts Here are some guides to different ways to help others contribute: ## Summer of Code Activities [activities:soc] **** ## Summer of Code Lots of development on Public Lab software happens as part of the [Rails Girls Summer of Code and Google Summer of Code programs](/soc), that latter supported generously by Google. Looking at the [GSoC Ideas list](/wiki/gsoc-ideas) is a great place to find projects which our community really needs to get done, whether or not you're in the program. Read more at our [Summer of Code page](/soc)! **** ### Miscellaneous Note that we encourage the use of external libraries -- it's certainly easier and more maintainable than developing our own code -- but we also encourage very clear links to such libraries' documentation, source code, and of course, attribution. ...

Author Comment Last activity Moderation
warren " @warren has marked liz as a co-author. " | Read more » about 6 years ago
warren "Hi, folks! One thing I wanted to suggest was also including an outreach plan in your proposals -- it doesn't need to be too long, but just some ide..." | Read more » about 6 years ago
sagarpreet "Hi @tech4gt ... i guess in the portal in Step 1 => you have to provide a Public link to Google docs . Step 2 => Provide some information on..." | Read more » about 6 years ago
tech4gt "Hello everyone, please help me with how to translate this proposal to the one that has to be submitted on google's website, as in should I just cop..." | Read more » about 6 years ago
warren "Hi, folks with API-related proposals! I've left a mix of comments on your various proposals: #soc-2018-api @milaaraujo @stefannibrasil @Raounak @s..." | Read more » about 6 years ago
warren "Hi, everyone -- just a note that if you want to link to your contributions to Public Lab so far, on a given project, you can use this style of link..." | Read more » about 6 years ago
stefannibrasil "Yes, awesome! Thanks, @warren for this :) " | Read more » about 6 years ago
bansal_sidharth2996 "Thanks @warren for the tips " | Read more » about 6 years ago
warren "Hi, @stefannibrasil -- thanks, great question! As a baseline, i love to see people who've made an initial contribution and shown that they are goo..." | Read more » about 6 years ago
stefannibrasil "Since this Note is about RGSoc and GSoC, I was wondering: what do you value most while reviewing applications? Coul you tell more about what do you..." | Read more » about 6 years ago
warren "@bansal_sidharth2996 @sagarpreet @vidit @tech4gt @vishesh @namangupta @500swapnil @mridulnagpal thanks everybody! Please check out the link in my l..." | Read more » about 6 years ago
warren "Hi! Yes, a project can be a collection of smaller features, that's fine! Even with bigger projects we prefer to see them broken into smaller parts ..." | Read more » about 6 years ago
sagarpreet "Hi @warren , i would love to work on Social Media Integration project . I have some initial implementation of fetching tweets and showing to a temp..." | Read more » about 6 years ago
warren "We're going to flesh out the ideas page with these as we go! Not every one will make it. Thanks! " | Read more » about 6 years ago
bansal_sidharth2996 "@warren Are these js and ideas listed in the comment section of this question also included for the gsoc ideas for this summer? They are not listed..." | Read more » about 6 years ago
Supun "I also would like to apply as a mentor. " | Read more » about 6 years ago
mridulnagpal "Sounds awesome!! Will prepare a research note on it right away!! " | Read more » about 6 years ago
mkashyap354 "I want to work as a mentor for GSOC 2018 " | Read more » over 6 years ago
warren "Also, did you see, it got featured on the Leaflet plugins page!! " | Read more » over 6 years ago
warren "That'd be great, @mridulnagpal! I've been making a few... what do you have in mind? " | Read more » over 6 years ago
mridulnagpal "@warren Let's plan on new enhancements for Leaflet Blurred Location. I would love to make a research note like we did last time. " | Read more » over 6 years ago
warren "Lots of answers from all over, especially @liz and @stevie: UI work on Questions pages https://p..." | Read more » over 6 years ago
zengirl2 "So I think that means people would have to embed their hashtags in the title of their post like: Replication of Hydrogen Sulfide Detection #airqual..." | Read more » over 6 years ago
warren "I like this idea. We're soon going to be tweaking the auto-tweet function. We use -- any suggestions? We currently use this recipe: This..." | Read more » over 6 years ago