Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WAITP-1502: code guidelines #5293

Merged
merged 8 commits into from
Dec 21, 2023
Merged

WAITP-1502: code guidelines #5293

merged 8 commits into from
Dec 21, 2023

Conversation

alexd-bes
Copy link
Contributor

Issue WAITP-1502: code guidelines

Changes:

  • Added contributing guidelines
  • Updated code of conduct to latest version

Copy link
Member

@edmofro edmofro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @acdunham!


This project and everyone participating in it is governed by the
[BES Open Source Code of Conduct](code-of-conduct.md).
By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@bes.au](opensource@bes.au).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have created this email address, forwards to me

All open-source contributors to Tupaia will be required to sign a Contributor License Agreement (CLA)
before BES can accept your contribution into the project code. This is done so that we can continue
to maintain the codebase covered by a single license. Signing a CLA can be done through GitHub
before merging in your first pull request.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It really can? That's cool.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually copied this from Michelle's and it was reviewed by Felix, so I assume that's right? But also happy to remove

to maintain a cohesive vision for the project. While we encourage collaboration and contributions,
we also want to avoid fragmentation that could compromise Tupaia's usability, maintainability,
and value. We believe that the best way to contribute is to align your efforts with our existing
product roadmap.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recognise this as my own writing! Nice. Must've come through from Slab.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/code-of-conduct.md Outdated Show resolved Hide resolved
Comment on lines 47 to 71
## Enforcement guidelines

### 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 behavior, 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can simplify these, given how immature and small our community is likely to be. Let's just go for "1. Warning" and "2. Temporary or Permanent Ban". The first can have the content from the existing "Correction", and the second the content from the "Temporary Ban" with a tweak:

"A ban from any sort of interaction or public communication with the community, either permanently or 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."

alexd-bes and others added 3 commits December 22, 2023 11:44
Co-authored-by: Edwin Monk-Fromont <edwin.monkfromont@gmail.com>
Co-authored-by: Edwin Monk-Fromont <edwin.monkfromont@gmail.com>
Copy link
Member

@edmofro edmofro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!
I think leave that CLA thing as is, and we'll try to make it work (following here )

@alexd-bes alexd-bes merged commit cf63c6e into dev Dec 21, 2023
42 checks passed
@alexd-bes alexd-bes deleted the waitp-1502-code-guidelines branch December 21, 2023 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants