5. Getting Ready to Contribute

Contributing to open source projects is a rewarding experience. Before making your first contribution, it's important to understand the etiquette and conventions of the community.

Before contributing, ALWAYS read:

README.md

The README file is the first stop. It contains: - What does the project do? - How to install it - How to use it - Links to additional documentation

CONTRIBUTING.md

This file explains how to contribute:

  • How to report bugs
  • How to suggest improvements
  • Process for submitting code
  • Code standards
  • How to run tests

CODE_OF_CONDUCT.md

The code of conduct establishes the community's rules of behavior.

  • Respect and courtesy
  • Inclusive language
  • Accepting constructive criticism
  • Focusing on the good of the community
  • Consequences for bad behavior

LICENSE

The license determines how the code can be used.

  • MIT: Very permissive, you can do almost anything
  • Apache 2.0: Permissive, requires attribution
  • GPL: Copyleft, derived code must be GPL
  • BSD: Similar to MIT
Building SPAs with Django and HTML Over the Wire: Learn to build real-time single page applications with Python

Building SPAs with Django and HTML Over the Wire: Learn to build real-time single page applications with Python

The HTML over WebSockets approach simplifies single-page application (SPA) development and lets you bypass learning a JavaScript rendering framework such as React, Vue, or Angular, moving the logic to Python. This web application development book provides you with all the Django tools you need to simplify your developments with real-time results.

Buy the book

Help me keep writing

Every coffee gives me a push toward the next article.

Comments

There are no comments yet.