Share my experience on how to contribute to the open source world

1. CONTRIBUTING TO
STRONGLOOP
LOOPBACK
Supasate Choochaisri
@ Code Chill Chill
15 July 2016
(and other open source projects)

2. ABOUT ME
Supasate Choochaisri (Ping)
Larngear Technology & Streaming Co., Ltd.
Thai Programmer Association
IBM Inventor: LoopBack Developer Level II
supasate.c@gmail.com
github.com/supasate
@kaizerwing

3. JUST STARTED CONTRIBUTING

4. WHAT IS
STRONGLOOP LOOPBACK?
•github.com/strongloop/loopback
•A popular open source Node.js
framework
•For composing scalable APIs

5. Define Model

6. Model Auto Creation

7. http://localhost:3000/explorer

12. MORE INFO
• loopback.io
• strongloop.com/node-js/loopback-
framework
• www-
03.ibm.com/software/products/en/
api-connect

13. HOW DID I START
CONTRIBUTING TO
LOOPBACK?

14. Myth
Only good developers
contribute to open source

15. Fact
Contribute to open source
to become a good or better
developer

16. START LIKE A BEGINNER

21. No one responds to my PR

24. Forgot to follow up

26. Tried installing and failed

27. Submitted a PR

28. Yeah!!! My first merged PR

29. Run test and failed at eslint
and landed my second PR

30. WANT TO TRY ON
LARGER PROJECT

32. Find issues

33. Filter by beginner-friendly label

34. Filter by beginner-friendly label

36. Fix it and submit PRs (Pull Request)

38. Released

39. Released

40. CONTRIBUTION
PROCESS
(can be applied to several projects)

41. README

42. Docker docs

43. DOCS.DOCKER.COM/OPENSOURCE/WORKFLOW/MAKE-A-CONTRIBUTION/

44. LoopBack similar process
https://github.com/strongloop/loopback/wiki/Contributing-code#submitting-a-pull-request

45. https://github.com/strongloop/loopback/wiki/Contributing-code#submitting-a-pull-request
LoopBack similar process

46. https://github.com/strongloop/loopback/wiki/Contributing-code#signing-patches
SIGNING PATCHES

47. https://github.com/strongloop/loopback/wiki/Contributing-
code#contributor-license-agreement
CONTRIBUTOR LICENSE AGREEMENT

48. STEP BY STEP
IN REAL ACTION

49. A FEW DAYS AGO
I SAW AN ISSUE
THAT MIGHT BE ABLE
TO BE SOLVED
BEFORE THIS TALK

52. 1) FORK REPO

53. 1) FORK REPO

54. 2) CLONE FORKED REPO

55. 2) CLONE FORKED REPO

56. 3) ADD UPSTREAM REPO

57. 3) ADD UPSTREAM REPO

58. 4) PREPARE ENVIRONMENT

59. 5) FEEL THE RUNNING PROJECT
(COMPILE / RUN / TEST)

60. 5) FEEL THE RUNNING PROJECT
(COMPILE / RUN / TEST)

61. 6) CREATE NEW BRANCH

62. 7) THE HARDEST PART:
FIND, UNDERSTAND, FIX
• Ask project owner where to start
• Search with keyword
• Method call tracing
• Debugging tool
• etc.

63. 7.1) MODIFY CODE
(I found in code that the issue was actually solved so I just added a test to cover)

64. 7.2) RUN TEST (BEFORE COMMIT)

65. FIX ERROR UNTIL THERE IS NO ERROR

66. 8) ADD & COMMIT & SIGN-OFF

67. 8) ADD & COMMIT & SIGN-OFF

68. 9) REBASE WITH UPSTREAM
(UPSTREAM MIGHT CONTAIN NEW
CHANGES WHILE WE WERE FIXING)

69. 10) PUSH TO YOUR FORKED REPO
local branch remote branch

70. 11) OPEN A PULL REQUEST (PR)

71. Short title
Description

72. 12) CHECK STATUS
Bot

73. 12) CHECK STATUS
one time per repo

74. 13) AGREE CONTRIBUTOR LICENSE AGREEMENT
(ONE TIME PER REPO)

75. 13) AGREE CONTRIBUTOR LICENSE AGREEMENT
(ONE TIME PER REPO)

76. 14) CHECK CONTINUOUS INTEGRATION STATUS

77. 15) NOTIFY A VERIFIER TO TAKE A LOOK

78. 15) NOTIFY A VERIFIER TO TAKE A LOOK

79. 16) READ COMMENTS

80. 16) READ COMMENTS

81. 17) FIX
Fix it, then, npm run test

82. 17) FIX

83. GIT LOG

84. 18) SQUASH INTO ONE COMMIT
Interactive mode
2 commits from HEAD

85. 18) SQUASH INTO ONE COMMIT

86. 18) SQUASH INTO ONE COMMIT

87. 18.1) CHOOSE COMMIT MESSAGE

88. 18.1) CHOOSE COMMIT MESSAGE

89. 19) FORCE PUSH
(WARNING: HISTORY WILL BE RE-WRITTEN)

90. 20) CHECK STATUS
(THIS CASE REBASE NEEDED)

91. 21) REBASE AND PUSH AGAIN

93. (OPTIONAL) LOOK CI STATUS

94. PR IS MERGED!

95. DOCS.DOCKER.COM/OPENSOURCE/WORKFLOW/MAKE-A-CONTRIBUTION/

96. ENJOY CONTRIBUTING!!!
Supasate Choochaisri (Ping)
github.com/supasate
@kaizerwing
supasate.c@gmail.com