Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

60 lines (35 loc) · 2.55 KB

How to contribute to Cozy Connector?

Thank you for your interest in contributing to Cozy! There are many ways to contribute, and we appreciate all of them.

Security Issues

If you discover a security issue, please bring it to our attention right away! Please DO NOT file a public issue, instead send your report privately to security AT cozycloud DOT cc.

Security reports are greatly appreciated and we will publicly thank you for it. We currently do not offer a paid security bounty program, but are not ruling it out in the future.

Bug Reports

While bugs are unfortunate, they're a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something is a bug or not, feel free to file a bug anyway.

Opening an issue is as easy as following this link and filling out the fields. Here are some things you can write about your bug:

  • A short summary
  • What did you try, step by step?
  • What did you expect?
  • What did happen instead?
  • What is the version of the Cozy Connector?

Pull Requests

Please keep in mind that:

  • Merge-Requests point to the master branch
  • You need to cover your code and feature by tests
  • You may add documentation in the /docs directory to explain your choices if needed
  • We recommend to use task lists to explain steps / features in your Merge-Request description
  • You do not need to build app to submit a MR

Workflow

Merge requests are the primary mechanism we use to change Cozy. GitLab itself has some great documentation on using the Merge Request feature. Patches should be sent via GitLab merge requests. You should create an account on gitlab.com, fork the repository, push your changes to a branch in your new repository, and then submit these patches for review through a merge request.

Writing documentation

Documentation improvements are very welcome. We try to keep a good documentation in the /docs folder. But, you know, we are developers, we can forget to document important stuff that look obvious to us. And documentation can always be improved.

Community

You can help us by making our community even more vibrant. For example, you can write a blog post, take some videos, answer the questions on the forum, organize new meetups, and speak about what you like in Cozy!