Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in the Flagsmith community a harassment-free
experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics,
gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance,
race, caste, colour, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behaviour that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
- Assuming good intent, and remembering that contributors are volunteering their time and expertise

Examples of unacceptable behaviour include:

- The use of sexualised language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behaviour and will take
appropriate and fair corrective action in response to any behaviour that they deem inappropriate, threatening,
offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, including this repository, our
[Discord server](https://discord.gg/hFhxNtXzgm), and any other Flagsmith-run forum. It also applies when an individual
is officially representing the community in public spaces. Examples of representing our community include using an
official email address, posting via an official social media account, or acting as an appointed representative at an
online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders
responsible for enforcement at support[at]flagsmith[dot]com. All complaints will be reviewed and investigated promptly
and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome in the
community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
and an explanation of why the behaviour was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behaviour. No interaction with the people involved, including
unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
interactions in community spaces as well as external channels like social media. Violating these terms may lead to a
temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behaviour.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
period of time. No public or private interaction with the people involved, including unsolicited interaction with those
enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1,
available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq.
Translations are available at https://www.contributor-covenant.org/translations.
39 changes: 28 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,51 @@
# Contributing Guide

We're always looking to improve this project, and we welcome your participation! Flagsmith accepts contributions via GitHub pull requests (PRs). This guide is intended to help ensure the success of your contribution.
We're always looking to improve this project, and we welcome your participation! Flagsmith accepts contributions via
GitHub pull requests (PRs). This guide is intended to help ensure the success of your contribution.

This project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to abide by its
terms.

## Create an issue

Before opening a PR, we encourage you to [create an issue](https://github.com/Flagsmith/flagsmith/issues/new/choose) describing your problem or feature request.
Before opening a PR, we encourage you to [create an issue](https://github.com/Flagsmith/flagsmith/issues/new/choose)
describing your problem or feature request.

We don't leave PRs unattended, but it will be easier for us to prioritise a review of your PR when there is a relevant issue at hand.
We don't leave PRs unattended, but it will be easier for us to prioritise a review of your PR when there is a relevant
issue at hand.

You can submit a PR directly for problems such as spelling mistakes or other things where it's clear what the problem is.
You can submit a PR directly for problems such as spelling mistakes or other things where it's clear what the problem
is.

If you decide to create an issue, be sure to search for an existing one first.

## Find an issue

If you are prepared to contribute but are uncertain as to how, consider narrowing your search with issue filters. For instance:
- [is:issue state:open type:Bug no:assignee](https://github.com/Flagsmith/flagsmith/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20no%3Aassignee) includes all current bugs.
- [is:issue state:open label:"good first issue" no:assignee](https://github.com/Flagsmith/flagsmith/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20no%3Aassignee) lists issues we think are good for newcomers.
If you are prepared to contribute but are uncertain as to how, consider narrowing your search with issue filters. For
instance:

- [is:issue state:open type:Bug no:assignee](https://github.com/Flagsmith/flagsmith/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20no%3Aassignee)
includes all current bugs.
- [is:issue state:open label:"good first issue" no:assignee](https://github.com/Flagsmith/flagsmith/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20no%3Aassignee)
lists issues we think are good for newcomers.

## Submit a PR

1. The target branch should always be set to `main`, unless otherwise asked in the respective issue.
1. An approved PR is eventually merged into `main`. Documentation changes will get deployed immediately afterwards. Your frontend changes will get deployed to SaaS, and you can expect both backend and frontend changes to be included in the next release.
1. An approved PR is eventually merged into `main`. Documentation changes will get deployed immediately afterwards. Your
frontend changes will get deployed to SaaS, and you can expect both backend and frontend changes to be included in
the next release.

To learn how we write PR titles and descriptions, structure reviews, and address feedback, see [PR_COLLABORATION.md](https://github.com/Flagsmith/AGENTS.md/blob/main/PR_COLLABORATION.md). It's the guide our team and review agents follow, and we encourage you to follow it as well.
To learn how we write PR titles and descriptions, structure reviews, and address feedback, see
[PR_COLLABORATION.md](https://github.com/Flagsmith/AGENTS.md/blob/main/PR_COLLABORATION.md). It's the guide our team and
review agents follow, and we encourage you to follow it as well.

## Setup local development

The development tooling is intended for use with Linux or macOS, and [GNU Make](https://www.gnu.org/software/make/). Consider using Windows Subsystem for Linux (WSL) to develop on Windows.
The development tooling is intended for use with Linux or macOS, and [GNU Make](https://www.gnu.org/software/make/).
Consider using Windows Subsystem for Linux (WSL) to develop on Windows.

To install Git hooks, run `make install-hooks`.

Each component provides its own Makefile in its respective subdirectory, and documents its usage and dependencies in a `README.md` file.
Each component provides its own Makefile in its respective subdirectory, and documents its usage and dependencies in a
`README.md` file.
Loading
Loading