Skip to content

Instantly share code, notes, and snippets.

@PurpleBooth
Last active April 14, 2024 19:19
Show Gist options
  • Save PurpleBooth/b24679402957c63ec426 to your computer and use it in GitHub Desktop.
Save PurpleBooth/b24679402957c63ec426 to your computer and use it in GitHub Desktop.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

@debrajhyper
Copy link

❤️

@chrisreddington
Copy link

Perfect, thanks a lot!

@felixbd
Copy link

felixbd commented May 22, 2021

Thx ^^

@shobhi1310
Copy link

Well ... I think that is a CoC, not contributing guidelines! Am I right?

yes I believe its CoC.

@OkomoJacob
Copy link

Epic 🔥

@Konrad1991
Copy link

Thanks a lot

@LucianoHanna
Copy link

Thanks! ❤

@saurabhmehta1601
Copy link

Well ... I think that is a CoC, not contributing guidelines! Am I right?

I also think so

@Semo
Copy link

Semo commented Nov 8, 2021

❤️

@aspirantzhang
Copy link

❤️

@rafaelcascalho
Copy link

Thank you very much! I'll recommend this, helps to start fast and reliably. ❤️ 💯

@Cerabbite
Copy link

Cerabbite commented Feb 1, 2022

Thanks
I have a question my repository already has a code of conduct file should I then just remove the code of conduct part from this file?

@PurpleBooth
Copy link
Author

PurpleBooth commented Feb 1, 2022

Hi @kevingiesberts, I actually don't use this style anymore, I leave this up so I don't break peoples links, this is what I would consider a reasonable start for a contributing - https://github.com/PurpleBooth/a-good-readme-template/blob/main/CONTRIBUTING.md

Removing the code of conduct from this file is totally fine.

@Cerabbite
Copy link

@PurpleBooth thank you

@jose1113
Copy link

Thanks

@nicolasdb
Copy link

Thanks :)

@reliaboe
Copy link

reliaboe commented Aug 2, 2022

Thanks :-)

@Bazzly
Copy link

Bazzly commented Aug 2, 2022

nice one dear. I will be using your this Good-CONTRIBUTING.md-template.md format to all the bad contributing projects we have on GitHub. i will do as many as i can

@Pdfulkar
Copy link

I will use it on the other projects.

@bluebamus
Copy link

Thank you :)

@felipelssilva
Copy link

marvelous <3

@GaeaKat
Copy link

GaeaKat commented Nov 17, 2022

You may be interested to know copilot links here if people start writing a README.md that has a section on contributing.

@Casmo
Copy link

Casmo commented Jan 4, 2023

Not just co-pilot, ChatGPT as well!

@PurpleBooth
Copy link
Author

Not sure how I feel about this, it's pretty old now 😅

@GaeaKat
Copy link

GaeaKat commented Jan 5, 2023

Not sure how I feel about this, it's pretty old now 😅

Once found this your other comment lead me to your https://github.com/PurpleBooth/a-good-readme-template/blob/main/CONTRIBUTING.md repo which based mine off

@aqpanaciy
Copy link

❤️

@benjaminnkem
Copy link

Thanks Bruv 💖

@Axnjr
Copy link

Axnjr commented Dec 8, 2023

Thanks man

@Dirac12
Copy link

Dirac12 commented Feb 16, 2024

Thanks!

@ShamoX
Copy link

ShamoX commented Feb 22, 2024

Thanks ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment