├── LICENSE ├── ProjectMaintainers.md └── ReadMe.md /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 pkafei 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /ProjectMaintainers.md: -------------------------------------------------------------------------------- 1 | ## Tips for Project Maintainers 2 | 3 | 1. Label the complexity of the issues (i.e. 'criticical', 'enhancement', 'good for new new comers') 4 | 2. Prompt and timely communication- it is a good idea to have an irc channel or to use [Gitter](https://gitter.im/) 5 | 3. Diversify your professional circle, if you are a developer and you need a designer, try to hang out with designers. 6 | 4. Create clear [documentation](http://docs.writethedocs.org/writing/beginners-guide-to-docs/) 7 | 8 | 9 | 10 | 11 | Resources: 12 | 13 | 1. [Tips for keeping your Open Source Software issues tracker tidy](http://blog.plataformatec.com.br/2014/05/tips-for-keeping-your-open-source-software-issues-tracker-tidy/) 14 | 2. [18F Maintainer Guidelines](https://18f.github.io/open-source-program/pages/maintainer_guidelines/) 15 | 3. [Open Source Development Guidelines](http://wiki.civiccommons.org/Open_Source_Development_Guidelines) 16 | 4. [Tips for New Open Source Maintainers](https://lord.io/blog/2014/oss-tips/) 17 | 5. [Mentored Bugs and You](http://www.joshmatthews.net/deck.js/mentor/#title-slide) 18 | 6. [Source Quest!](https://medium.com/@trek/source-quest-ff7d227d8fed) -------------------------------------------------------------------------------- /ReadMe.md: -------------------------------------------------------------------------------- 1 | # Guide to Contributing to Open Source 2 | 3 | ### What is open source software? 4 | 5 | Open Source software is a programming project that is maintained by the community. The code, design, and documentation can be freely accessed by the curious. 6 | 7 | ### What does it mean to contribute to open source software? 8 | 9 | Open source software is mostly maintained by volunteers. These people dedicate their time to ensure the code we're using is robust and up-to-date. 10 | 11 | ### Why should I contribute to open source? 12 | Trying to break into tech but don't know how? Writing documentation, designing, and programming will give you real-world experience in a working on a technical project. 13 | 14 | 15 | ### How can I contribute? I'm not a ninja coder. 16 | 17 | Contributing to open source is another way of volunteering. Think about it- if you had a soup kitchen would you only accept chefs as volunteers? Of course not. It takes a team of different skilled professionals to make a project successful. Open source projects are in dire need of quality documentation, and intuitive graphic design. 18 | 19 | ## List of Open Source Projects and Resources 20 | 21 | 22 | 23 | ### Mentoring for New Comers 24 | 1. [Open Hatch] (https://openhatch.org/) 25 | 2. [Mozilla Introduction](https://developer.mozilla.org/en-US/docs/Introduction) and [Bugs Ahoy!] (http://www.joshmatthews.net/bugsahoy/) 26 | 3. [OutReachy](https://wiki.gnome.org/Outreachy/2015/MayAugust/SpreadTheWord?action=AttachFile&do=view&target=outreachy-poster-2015-May-August.png) (paid opportunity) 27 | 28 | ### Open Source Projects 29 | 1. [Wikipedia](http://www.wikihow.com/Contribute-to-Wikipedia) 30 | 2. [Civic Tech Issue Finder](https://www.codeforamerica.org/geeks/civicissues) 31 | 3. [Contributing to WordPress](https://codex.wordpress.org/Contributing_to_WordPress#WordPress_Support_Forum) 32 | 4. [Ubuntu](http://community.ubuntu.com/contribute/) 33 | 5. [Writing your first patch for Django](https://docs.djangoproject.com/en/1.8/intro/contributing/) 34 | 6. [Contributing to SciPy](https://github.com/scipy/scipy/blob/master/HACKING.rst.txt) 35 | 7. [How to Contribute to Calagator](https://github.com/calagator/calagator/wiki/How-To-Contribute-To-Calagator) 36 | 8. [Contribute to Pyladies](https://github.com/pyladies/pyladies) 37 | 9. [Contribute to Read the Docs](http://docs.readthedocs.org/en/latest/contribute.html) 38 | 10. [Contribute to Django](https://docs.djangoproject.com/en/1.8/internals/contributing/) 39 | 11. [Contribute to OpenHatch](http://openhatch.org/search/?q=&toughness=bitesize) (links directly to bite-size bugs) 40 | 12. [Contribute to Growstuff](http://wiki.growstuff.org/index.php/Development/Newbie_guide) 41 | 42 | 43 | 44 | ### Useful Technologies 45 | 1. [Git- The Simple Guide] (http://rogerdudler.github.io/git-guide/) 46 | 2. [Interactive Git Tutorial](https://try.github.io/levels/1/challenges/1) 47 | 3. [Getting Up and Running in IRC] (http://www.wikihow.com/Get-Started-with-IRC-%28Internet-Relay-Chat%29) 48 | 4. [Learn the Command Line the Hard Way](http://cli.learncodethehardway.org/book/) 49 | 5. [A beginners Guide to Writing Good Documenation](http://docs.writethedocs.org/writing/beginners-guide-to-docs/) 50 | 51 | ### More Resources 52 | 1. [What is Open Source?](http://www.codenewbie.org/blogs/what-is-open-source) 53 | 2. [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) 54 | 3. [14 Ways of Contributing to Open Source Without Being a Rockstar or Genius](http://blog.smartbear.com/programming/14-ways-to-contribute-to-open-source-without-being-a-programming-genius-or-a-rock-star/) 55 | 4. [Why Technical People Should Blog (But Don't)](http://www.rackspace.com/blog/why-technical-people-should-blog-but-dont/) 56 | 5. ["Beginner Friendly Open Source Projects"](http://juliepagano.com/blog/2013/11/14/beginner-friendly-open-source-projects/) 57 | 58 | --------------------------------------------------------------------------------