Skip to content

Latest commit

 

History

History
89 lines (54 loc) · 5.12 KB

CONTRIBUTING.md

File metadata and controls

89 lines (54 loc) · 5.12 KB
Raw

GlobaLeaks Contributing Guide

Hi! We are really excited that you are interested in contributing to GlobaLeaks.

As a contributor, here are the guidelines we would like you to read:

Code of Conduct

Help us keep GlobaLeaks community safe and inclusive. Please read and follow our Code of Conduct.

Got a Question or Problem?

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Instead, we recommend using our Discussion Forum space to ask support-related questions.

If you would like to chat about the question in real-time, you can reach out via Community Chat.

Found a Bug?

If you find a bug in the source code, you can help us by Opening a Ticket to our Ticketing System. Even better, you can Submit a Pull Request with a fix.

Do you have a Feature Idea?

You can suggest a new feature by Opening a Ticket to our Ticketing System. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

  • Small Features can be crafted and directly Submitting a Pull Request.

Submission Guidelines

Opening a Ticket

Before you open a ticket, please search through the List of Tickets. A ticket for your problem might already exist and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase, but we really need to isolate the problem before we can fix it.

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.

You can file new issues by selecting from our new issue templates and filling out the issue template.

Submitting a Pull Request

Before you submit your Pull Request consider the following guidelines:

  1. Search on the List of Pull Requests for an open or closed pull requests that relates to your contribution. You don't want to duplicate existing efforts.

  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  3. Fork the GlobaLeaks repository.

  4. In your forked repository, make your changes in dedicated git branch.

  5. Create your patch, documenting your code and including appropriate test cases.

  6. Follow standard coding guidelines for each specific language.

  7. Run the full GlobaLeaks test suite and ensure that all tests pass.

  8. Commit your changes using a descriptive commit message.

  9. In GitHub, send a pull request to GlobaLeaks:main.

Donations heart icon

As a pure community-driven project without major corporate backing, we also welcome donations.

A big thank you to everyone who has already contributed or donated to the development of GlobaLeaks!