List of Resources for Software Developers new to OSS projects.

oss-new-sw-dev-resources.md

List of Resources for Software Developers new to OSS projects.

General

1. First pull request initiatives

   • https://twitter.com/yourfirstpr
   • https://github.com/yourfirstpr
   • lower the barrier https://the-pastry-box-project.net/charlotte-spencer/2015-september-16
   • first timers (maybe we shouldn't be so strict as only first timers, but we can refer to some concepts here) https://medium.com/@kentcdodds/first-timers-only-78281ea47455

2. Writing better commit messages, possibly with emojis

   • https://medium.freecodecamp.com/towards-better-git-commit-messages-using-atom-6dbda5e14984
   • commit message format https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format
   • commit message types with emojis https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages

3. Open open source model http://openopensource.org/ with few and simple guidelines

4. Applying good labels to Github issues

   • https://robinpowered.com/blog/best-practice-system-for-organizing-and-tagging-github-issues/
   • https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63

5. Applying GitHub pull request / issues templates

   • https://github.com/blog/2111-issue-and-pull-request-templates
   • templates https://github.com/stevemao/github-issue-templates
   • good for the community manager to look for more samples and guide the teams to tweak for their own use case instead of just copy pasting

6. Adding contributing guidelines

   • https://github.com/blog/1184-contributing-guidelines
   • another opportunity for the community manager to facilitate research on various contributing
   • guidelines and tweaking them for each project

7. Creating a good readme file

   • https://github.com/matiassingers/awesome-readme
   • plenty of good examples and another opportunity for exploration on what to include
     • screenshot
     • one sentence description
     • demo link
     • getting started in 3 steps table of contents
     • badges for ci / test coverage

8. Badges to include: CI, coverage, security, etc

   • https://github.com/badges/shields
   • various service with badges https://github.com/badges/shields#services-using-the-shields-standard

9. How to create GIF

   • https://licecap.en.softonic.com/
   • make fun gifs https://giphy.com/

10. ASCII art

    • text to ascii http://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type%20Something%20
    • pic to ascii http://picascii.com/

11. Smart ways to embed hidden fun messages for developers

    • http://elijahmanor.com/find-good-devs/
    • https://coderwall.com/p/fskzdw/colorful-console-log
    • but don't over do it i guess LOL https://i.imgur.com/4Fgi3vA.png

12. Common git branching models

    • GitHub flow (more fun, relaxed, easy for students / beginners)
    • https://guides.github.com/introduction/flow/
    • Git flow (complicated - better to refer to it later in full-time profession)
    • Comparison https://lucamezzalira.com/2014/03/10/git-flow-vs-github-flow/
    • https://www.youtube.com/watch?v=juLIxo42A_s
    • https://zachholman.com/talk/how-github-uses-github-to-build-github/
    • plenty of research materials on Google!
    • Swift by Apple uses only PR models of patches, with no issues https://github.com/apple/swift

13. Using git as markdown based documentation

    • https://github.com/search?utf8=%E2%9C%93&q=documentation&type=
    • https://github.com/sindresorhus/awesome

14. humans.txt for web projects http://humanstxt.org/

Examples of Singapore based open source

- Example of Singapore based open source in NUS https://github.com/TEAMMATES/teammates    - see the issues tab for beginner friendly labels
- We Build SG repos list https://webuild.sg/api/v1/repos (view with browser JSON viewer extension!) 

Other skills

- How to ask questions? http://www.catb.org/esr/faqs/smart-questions.html#before 
- How to reproduce a bug