Skip to content
Snippets Groups Projects
Select Git revision
  • 2301.4.x protected
  • 24.0.x
  • 24.x.x
  • main default protected
  • 2301.x.x protected
  • 2301.3.x
  • 21.03 protected
  • 2301.2.x
  • 20.03 protected
  • 20.10 protected
  • 19.04 protected
  • 18.10 protected
  • 18.04 protected
  • 17.06 protected
  • CMIS
  • 2301.4.7
  • 2301.4.6
  • 2301.4.5
  • 2301.4.4
  • 24.0.2
  • 2301.4.3
  • 2301.4.2
  • 2301.4.1
  • 2301.4.0
  • 2301.3.7
  • 2301.3.6
  • 21.03.33
  • 2301.3.5
  • 2301.3.4
  • 2301.3.3
  • 2301.3.2
  • 2301.3.1
  • 2301.3.0
  • 2301.2.2
  • 2301.2.1
35 results
Blame Permalink
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 13.72 KiB

NOTA : this document is still in work in progress

Contributing to Maarch

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to Maarch and its packages, which are hosted in the Maarch Organization on Maarch GitLab. Use your best judgment, and feel free to propose changes to this document in a merge request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

Styleguides

What should I know before I get started?

Contributor Agreement

Anyone wishing to contribute to Maarch Courrier must read & sign our Contributor License Agreement. The Maarch team is legally prevented from accepting any merge requests from users who have not signed the CLA first.

About Maarch Courrier

Maarch Courrier is a professional DMS that natively answers a vast majority of the needs for operational document management. It is released under the terms of the free and open source license GNU/GPLv3. One of the consequence is that Maarch software is affordable for any kind of organisation.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Maarch. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Before Submitting A Bug Report

  • Check the FAQs on the wiki. You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem in the latest version of Maarch.
  • Determine which repository the problem should be reported in.
  • Perform a cursory search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as Gitlab issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Maarch, e.g. which command method you used in the browser. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut, and if so which one?
  • Provide specific examples to demonstrate the steps. Include links to files or GitLab projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • If you're reporting that Maarch crashed, include a crash report with a stack trace from the operating system. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
  • If the problem is related to performance, include a CPU profile capture and a screenshot with your report.
  • If the Firefox or Chrome's developer tools pane is shown without you triggering it, that normally means that an exception was thrown. The Console tab will include an entry for the exception. Expand the exception so that the stack trace is visible, and provide the full exception and stack trace in a code blocks and as a screenshot.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of Maarch) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Maarch? What's the most recent version in which the problem doesn't happen?.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of Maarch are you using?.
  • What's the name and version of the OS and Maarch prerequisites you're using?
  • Are you running Maarch in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?