How to contribute

How to contribute to Weam.

Contributing

Contributions must follow the following steps:

  • Create a branch
  • Add commits
  • Open a pull request
  • Exchange and review the code
  • Deploy to production
  • Merge

This is the development process recommended by Github, the details of which you can find on this page.

If you are not yet a contributor but would like to contribute to the project on a regular basis, you can request this status on the discord server to access more resources and exchange with other team members.

If you are not a contributor but still want to contribute to the project, you can submit pull requests! These should contain a description detailing the changes to the project and will all be subject to a code review before being accepted.

Bugs report & issues

If you encounter an issue or bug while using the platform or analysing the code, but you are not a contributor, there are two possible solutions:

  • You can report the bug directly to the github repository by opening an issue.
  • You can fix this bug by opening a pull request and following the procedure described above.

Licenses

The project is developed under the AGPL license.

This blog and its documentation are written under the Creative Commons by ND license. The sharing conditions are available on this page.

Application development

  • Comment at least succinctly on the role of the functions developed.
  • The development of the API must respect the principle of a stateless API, with no memory between the different requests:
    • GET: return of selected data
    • POST: persistence of non-existent data
    • PUT : modification of pre-existing data
    • DELETE : deletion of data
Product backlog →