Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (13 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

23 lines (13 loc) · 1.69 KB

Contributing guidelines

Follow the Arch Linux Code Of Conduct (COC)

Commit guide

Follow FreeCodeCamp's commit message style guidelines

All commit messages and pull requests are expected to follow these guidelines.

Style guide

  • Code should be easily readable
  • Code should either be self-explanatory, or commented. You are expected to write documentation.
  • Improvements should either have no effect on developer experience (DE) or should improve it (see thoughts)

Some thoughts to keep in mind

The purpose of this project is to be a generally unopinionated (1) template that greatly improves the developer experience (DE) when trying to work with React as a frontend and Django as a backend. If an idea or potential change does not directly increase (or not affect) DE, it probably shouldn't be implemented.

Notes

  1. Unopinionated? Kinda? Maybe? This template strictly defines the way a developer should transfer data between their frontend and backend, and both React and Django have general guidelines as to how a project should be structured. However, the intention of this template is not to restrict developers to one single way to build a project. It is still simple to add or remove packages on both the frontend and backend, it is still practical to change the design of either the frontend or the backend (but not both), and for many more reasons, there is no one "right way" of doing something. Therefore, while the fundamental structure of this template may be opinionated, the little bits and pieces are not, and should not be.