Your first Open Source contribution at coala!
Satwik Kansal (~satwik) |
This Dev Sprint covers a hands-on introduction on contributing to an Open Source project. The knowledge attained from this session will help participants (especially beginners) to contribute to an Open Source project in general.
What is coala?
coala is a static code analysis framework. It provides a unified interface for linting and fixing code with a single configuration file, regardless of the programming languages used. You can use coala from within your favorite editor, integrate it with your CI, get the results as JSON, or customize it to your needs with its flexible configuration syntax.
The majority of coala’s codebase is written in Python. coala is known for being a newcomer-friendly project to begin with and we feel that it’s a good place to start contributing to this amazing world of Open Source Softwares.
- Introducing yourself to an Open source organization. (Becoming a "coalian" in our case)
- Brief introduction to git and Basic git commands (commit, push, rebase)
- Setting up the project.
- Using a bug tracker to find issues and working on them.
- Writing code to fix the issues and following code style guidelines.
- Making your first commit at coala and submitting a Pull Request.
- Reviewing other people’s code.
- Getting your Pull Request merged
Yay! You will be making your first contribution to coala.
- Enthusiasm to learn
- Love for Open Source.
- Basic programming knowledge in Python will be helpful but not necessarily required.
It is recommended to have following things installed on your machine:
- Python 3.x
- https://api.coala.io/en/latest/Developers/Development_Setup.html (Optional, we’ll be covering this at the beginning of the session)
- coala’s Newcomers guide: https://coala.io/newcomer
- Development setup notes for coala: https://api.coala.io/en/latest/Developers/Development_Setup.html
- Easy to solve issues for newcomers: https://coala.io/new and https://coala.io/low
- Codebase: https://github.com/coala/
I'm a freelance Software Developer, Google Summer Of Code 2017 student and contributor at coala. I like writing code, participating in Hackathons, and attending conferences. And lastly, I prefer all things Python!
Some fellow coala community members will also be joining me for mentoring and facilitating the session.