Skip to content

Commit

Permalink
Merge pull request #541 from Xpirix/contributors_requirements
Browse files Browse the repository at this point in the history
Contributors requirements
  • Loading branch information
Xpirix authored Feb 10, 2025
2 parents 5dc3114 + a272f7d commit cdf268e
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 2 deletions.
10 changes: 8 additions & 2 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -564,17 +564,23 @@ sectionPagesMenu = 'main'
url = "/resources/support/bug-reporting"
weight = 120

[[menu.main]]
parent = "Contact and Support"
name = "Contributor Requirements"
url = "/resources/support/contributors-requirements"
weight = 130

[[menu.main]]
parent = "Contact and Support"
name = "Communication channels"
url = "/resources/support/#communication-channels"
weight = 130
weight = 140

[[menu.main]]
parent = "Contact and Support"
name = "Commercial support"
url = "/resources/support/commercial-support"
weight = 140
weight = 150

[[menu.main]]
parent = "Contact and Support"
Expand Down
2 changes: 2 additions & 0 deletions content/community/involve.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ Interested in crafting your own? Learn how to get started!

QGIS Core comprises libraries for building custom applications through a robust API. It also includes desktop and server applications that showcase the library capabilities, providing a user-friendly interface

[Contributor Requirements]({{< ref "resources/support/contributors-requirements" >}})

[Get set up for QGIS Core development](https://docs.qgis.org/latest/en/docs/developers_guide/index.html )

[QGIS roadmap]({{< ref "resources/roadmap" >}})
Expand Down
62 changes: 62 additions & 0 deletions content/resources/support/contributors-requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
type: "page"
title: "Contributor Requirements"
subtitle: ""
draft: false
sidebar: true
---

{{< content-start >}}

# Contributor Requirements

## Requirements for new contributors

We welcome new contributors to our community - we want you to use QGIS as a platform for doing your work - and we believe that QGIS is a great platform for that. In order to contribute code, patches, or documentation to the QGIS project, all developers/team members must:

- Abide by the [Social Contract](#social-contract).

- Be familiar with the development process and the reference material available in the [Developers Guide for QGIS](https://docs.qgis.org/testing/en/docs/developers_guide/index.html), and the CODING document in the root of the QGIS Sources.

- Ensure that all code committed to the repository is unencumbered and compatible with the QGIS license, GNU Public License (GPL) Version 2 or any later version.

- Not use or include any code that will cause a trademark or patent infringement. If you are unsure, ask on the developer mailing list or contact a Project Steering Committee member.

- Join the qgis-developer mailing list and contribute to discussions

- These requirements apply to both developers desiring commit privileges and those that submit patches.

- Read and agree to the [Code of Conduct]({{< relref "conduct" >}}).

- Read and agree to the [Coding Standards](https://docs.qgis.org/testing/en/docs/developers_guide/codingstandards.html).

- Read and agree to the [Diversity statement]({{< relref "diversity" >}}).

- Agree to these requirements by sending an email to the qgis-developer mailing list stating agreement.

## Social Contract

QGIS is a collaborative project. As an open source project we hope for and encourage participation and code contributions from interested parties. However in order to maintain high standards we encourage you to participate in the project according to the following social contract:

- To be polite to all members of the project

- To ensure any code you submit via a patch or commit to source control is properly documented

- To ensure any code you submit via a patch or commit to source control is compliant with our CodingStandards

- Not to submit any code without having permission to submit that code

- Not to submit any code that violates the GNU Public License

- To follow the [Contributor Requirements](#contributor-requirements) mentioned above

- To ensure (to the best of your ability) that any commits you make to git leave the repository in a compilable state

- To ensure that any new class added to the source is accompanied by a test unit

- To carry out appropriate tests before committing new code to the repository

- To smile, laugh and crack a joke once in a while - we are all here to have fun!


{{< content-end >}}

0 comments on commit cdf268e

Please sign in to comment.