Developers
developers

[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](https://publiclab.org/notes/warren/05-22-2019/draft-of-a-public-lab-software-roadmap-comments-welcome)_ **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](https://code.publiclab.org#r=all)** 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](https://code.publiclab.org). If you'd like to quickly jump into an issue, see the following list for any available [first-timers-only issues](https://code.publiclab.org#r=all): 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 https://publiclab.org/software-overview Project Description Source Code PublicLab.org Ruby on Rails This very website!PublicLab.org - 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: https://github.com/publiclab ## 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: https://code.publiclab.org#r=all ### Resources #### Getting started * http://www.firsttimersonly.com/ * A very in-depth guide: https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github * https://guides.github.com/activities/contributing-to-open-source/ #### Setup * Lots on Ruby, Rails, databases and more: https://www.theodinproject.com/courses #### Pull requests * https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/ * the basic GitHub Flow workflow: https://guides.github.com/introduction/flow/ #### Git * Rebasing step by step: https://thinkup.readthedocs.io/en/latest/contribute/developers/devfromsource.html#workflow-diagram * guidance on rebasing: https://www.atlassian.com/git/tutorials/merging-vs-rebasing * revert a single file to a specific revision in Git: https://stackoverflow.com/questions/215718/reset-or-revert-a-specific-file-to-a-specific-revision-using-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: https://gist.github.com/n00neimp0rtant/9515611 **** ### 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](http://hood.ie) 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: https://github.com/publiclab/plots2/blob/main/app/assets/javascripts/dragdrop.js#L64 -- 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
liz "Amazing!!! What a stupendous pile of work! Congrats and thanks to all involved. " | Read more » over 6 years ago
ccpandhare "Thanks! And sure, @warren, I will modify the gh-pages branch at the soonest. " | Read more » almost 7 years ago
warren "@mridulnagpal has done this and can advise. Also I like your project page for organizing you progress! https://github.com/publiclab/image-sequenc..." | Read more » almost 7 years ago
warren "Hi, Chinmay- thanks!! I'm curious if you can test things on the gh-pages branch of your project, where the demo is running from. Could you try mer..." | Read more » almost 7 years ago
ccpandhare "Hello! On the Image Sequencer project, I have completed the core functionality of the module and will now be working on Unit tests for the same an..." | Read more » almost 7 years ago
warren "Just an update -- @Ashan has posted a demo! https://publiclab.org/notes/Ashan/06-14-2017/introducing-question-button-in-wiki-pages " | Read more » almost 7 years ago
stevie "Hi there! Excited about the GSoC projects! If anyone has things I could test out I'd love to check them out. Not a coding person, but I can run thr..." | Read more » almost 7 years ago
frankrasmussen "wow.. well done :) " | Read more » almost 7 years ago
ananyo2012 "Awesome! :) " | Read more » almost 7 years ago
liz "Thank you for this great effort @ananyo2012 and @yukiisbored, @oanarosca, @Abhi2424shek! Thank you to the FOSSASIA community for welcoming Public L..." | Read more » over 7 years ago
ananyo2012 "Thanks Jeff for the appreciation! I am also overwhelmed to see the number of contributors in our codebase and it keeps growing! " | Read more » over 7 years ago
liz "This is a great report, thanks for posting! " | Read more » over 7 years ago
Becki "Thanks for everyone's hard work on this. What an amazing amount of progress you all made this summer! " | Read more » over 7 years ago
liz "Epic amount of work everyone! Looking forward to the OpenHour coming up next week on Tuesday, September 6, at 1pm East Coast US time. Join us by vi..." | Read more » over 7 years ago
Lalithr95 "Sure I'll create them, Thanks ! " | Read more » over 7 years ago
warren "Hello, Lalith - thanks for your contributions this summer. The under-the-hood changes to enable profile tagging, and the careful thinking on the re..." | Read more » over 7 years ago
Lalithr95 "@cfastie Thanks for the feedback. Glad that you liked it :) cc: @liz @warren " | Read more » over 7 years ago
cfastie "Hooray, the list of barnstars can be toggled off in my profile! The new profile page looks excellent. I guess the rich profile tag function is stil..." | Read more » over 7 years ago
ananyo2012 "Thanks Jeff for your appreciation! You have been greatly helpful for me as well as other students throughout the summer. You have been working so h..." | Read more » over 7 years ago
warren "warren awards a barnstar to ananyo2012 for their awesome contribution! " | Read more » over 7 years ago
warren "Hi, Ananyo -- just going through all the projects one by one now. I wanted to thank you once again for such great work this summer -- you've been ..." | Read more » over 7 years ago
klie "Wow, this and your blog (obviously on top of all the excellent work you've put in) is awesome! Thanks for everything, Ananyo :) " | Read more » over 7 years ago
ananyo2012 "Thanks Jeff! I have been blogging during first half of my Project! I thought of sharing it with everyone once it was complete. Hope to add more of ..." | Read more » over 7 years ago
ananyo2012 "Also I have created a new Q & A Project milestone to list all the issues that relate to the Q & A Project. I have include it above: https:/..." | Read more » over 7 years ago