Download to read offline
Uploaded byDaniel Stenberg
Landing code in curl
The document outlines the process of contributing to the curl project, emphasizing the importance of community, communication, and the steps for submitting code changes via pull requests. It details the tools and methods used for code testing, review, and merging, highlighting the collaborative nature of the project and encouraging participation from contributors. Additionally, it provides resources for support and further development, showcasing the inclusive environment fostered by the curl community.
More Related Content
Landing code in curl
- 1.
- 2.
- 3.
- 4.
- 5. Q&A in theend!Q&A in the end! @bagder@bagder
- 6. @bagder@bagder Lessons on howto code – you know that already URLs to the various resources – you can find them Discussions on what tools to use – use whatever you like This presentation will not include @bagder@bagder
- 7. @bagder@bagder 2,200 contributors –200 new/year 820 authors – 100 new/year 15 active maintainers 30-50 in progress Pull-Requests in GitHub at all times You are not alone @bagder@bagder
- 8. @bagder@bagder Community & communicationin curl The curl-library mailing list Questions, support, brainstorms, suggestions, ideas, debugging, roadmap, feedback Issues and Pull-Requests on GitHub Bugs and improvements #curl IRC channel on Freenode Chit chat - anything @bagder@bagder HackerOne Security problems
- 9. @bagder@bagder We’re nice toeach other Code of Conduct @bagder@bagder
- 10. @bagder@bagder Clone the githubgit repository Since you’re going to change code, make your own fork Get the curl project’s code, not from anyone else hosting it Get the latest / master Get the curl code
- 11. @bagder@bagder Build the unmodifiedversion first Verifies you have the infra setup accordingly Autotools (configure), cmake and Windows build systems are supported ‘make test’ Build curl @bagder@bagder
- 12. @bagder@bagder Most of thecode is C89 Code style Documentation? Update or add tests? Change the curl code @bagder@bagder
- 13. @bagder@bagder ./configure --enable-debug make checksrc maketest Test your curl code @bagder@bagder
- 14. @bagder@bagder Commit the changein a local git branch Gold points: follow the git message template Git push the commit(s) in your curl fork Commit and push the codeCommit and push the code @bagder@bagder
- 15. @bagder@bagder Submit your dedicatedbranch in a pull request to curl/curl Listen to feedback, amend the branch to adapt The PR will trigger a large amount of CI jobs, tests and analyzes Watch incoming CI job results, amend the branch to adapt It might take a while to get human response Create a Pull Request on curl @bagder@bagder
- 16. @bagder@bagder No CLA orform to sign to contribute code By submitting code, you are assumed to have the right to For a large change, you can add your copyright line Must not interfere with or be incompatible with license curl copyright and license @bagder@bagder
- 17. @bagder@bagder Each PR triggers90+ builds Tests, sanitizers and analyses are run on many platforms with numerous setups and different configs Unfortunately, CI jobs sometimes fail as false positives Follow-up commits to the branch restarts the CI builds The curl CI system @bagder@bagder
- 18. @bagder@bagder Who reviews PullRequests?Who reviews Pull Requests? Anyone can Everyone is encouraged to Maintainers tend to watch out for “their areas” Daniel most likely will @bagder@bagder
- 19. @bagder@bagder Who decides what’sa good new feature? It must beIt must be URL/transferURL/transfer relatedrelated It is aIt is a discussiondiscussion – argue for your point– argue for your point DanielDaniel has the final sayhas the final say Old decisions can beOld decisions can be brought backbrought back @bagder@bagder
- 20. @bagder@bagder If you disagreewith a comment/remark: argue your case For small incremental changes, do a follow-up commit and push For larger changes, consider squashing commits and force- push a new take – to simplify the review process Did I mention ‘make checksrc’ ? Amend a Pull Request @bagder@bagder
- 21. @bagder@bagder Once all feedbackand test failures are addressed Bug-fixes can get merged any at point in the release cycle Features can only get merged when the feature-window is open Someone will merge it with a “Closes #1234” GitHub instruction Merging a Pull Request into curl @bagder@bagder
- 22. @bagder@bagder The next PRwill be easier! The first one is the hardestThe first one is the hardest The second time you know what to expectThe second time you know what to expect Consider reviewing other PRsConsider reviewing other PRs Help us improve docs for other first-timersHelp us improve docs for other first-timers @bagder@bagder
- 23. @bagder@bagder Everything is mergedvia PRsEverything is merged via PRs The same procedures and rules apply to everyone @bagder@bagder
- 24. @bagder@bagder All commits mergedinto the master branch At the time of the release There’s always another chance in the next release! We do releases every eight weeks Contents of a curl release @bagder@bagder
- 25. @bagder@bagder “scratch your ownitch” Existing issues on GitHub KNOWN_BUGS and TODO Need ideas of what to work on? @bagder@bagder
- 26. @bagder@bagder We are allon the same team Ask when in doubt We love you for helping out and being one of us We want you to succeed! @bagder@bagder
- 27.
- 28.
- 29. Daniel Stenberg @bagder https://daniel.haxx.se/ Thank you!Thankyou! Questions?Questions? @bagder@bagder
- 30. @bagder@bagder License This presentation andits contents are licensed under the Creative Commons Attribution 4.0 license: http://creativecommons.org/licenses/by/4.0/