Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

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

@Sylvainkossi

This comment has been minimized.

Copy link

@Sylvainkossi Sylvainkossi commented Nov 21, 2016

This helps a lot. Thanks

@yupferris

This comment has been minimized.

Copy link

@yupferris yupferris commented Jan 25, 2017

❤️ !!

@m1guelpf

This comment has been minimized.

Copy link

@m1guelpf m1guelpf commented Mar 2, 2017

❤️

@danitome24

This comment has been minimized.

Copy link

@danitome24 danitome24 commented Mar 6, 2017

❤️

@AidanHanda

This comment has been minimized.

Copy link

@AidanHanda AidanHanda commented Apr 6, 2017

❤️

@z0al

This comment has been minimized.

Copy link

@z0al z0al commented Apr 12, 2017

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

@thangarajan8

This comment has been minimized.

Copy link

@thangarajan8 thangarajan8 commented May 4, 2017

@DylanDelobel

This comment has been minimized.

Copy link

@DylanDelobel DylanDelobel commented Jul 21, 2017

❤️

@mclusky

This comment has been minimized.

Copy link

@mclusky mclusky commented Sep 28, 2017

Great stuff. thank you very much.

@RamsesMartinez

This comment has been minimized.

Copy link

@RamsesMartinez RamsesMartinez commented Oct 6, 2017

❤️

@inidaname

This comment has been minimized.

Copy link

@inidaname inidaname commented Oct 9, 2017

Thank You

@cnethers

This comment has been minimized.

Copy link

@cnethers cnethers commented Oct 24, 2017

Thanks for this !!

@davidgamez

This comment has been minimized.

Copy link

@davidgamez davidgamez commented Nov 19, 2017

❤️

@danielsouzapinna

This comment has been minimized.

Copy link

@danielsouzapinna danielsouzapinna commented Nov 28, 2017

Thanks!

@mgrc45

This comment has been minimized.

Copy link

@mgrc45 mgrc45 commented Dec 25, 2017

Thanks!

@hankchizljaw

This comment has been minimized.

Copy link

@hankchizljaw hankchizljaw commented Jan 5, 2018

Thanks for this! Awesome work :)

@masgui

This comment has been minimized.

Copy link

@masgui masgui commented Feb 9, 2018

<3

@softwar3d3v

This comment has been minimized.

Copy link

@softwar3d3v softwar3d3v commented Feb 24, 2018

❤️

@KeonHeeLee

This comment has been minimized.

Copy link

@KeonHeeLee KeonHeeLee commented Feb 25, 2018

Thanks!! :)

@zazapeta

This comment has been minimized.

Copy link

@zazapeta zazapeta commented Feb 27, 2018

Another Thanks !

@russomi

This comment has been minimized.

Copy link

@russomi russomi commented Mar 7, 2018

❤️

@LeonardMuia

This comment has been minimized.

Copy link

@LeonardMuia LeonardMuia commented Mar 25, 2018

Awesome

@securedeveloper

This comment has been minimized.

Copy link

@securedeveloper securedeveloper commented Apr 3, 2018

❤️

@odahcam

This comment has been minimized.

Copy link

@odahcam odahcam commented Apr 9, 2018

❤️

@tcompart

This comment has been minimized.

Copy link

@tcompart tcompart commented Apr 24, 2018

It really helpful and great contribution description! I like the details and the code of conduct included ♥️

@ghost

This comment has been minimized.

Copy link

@ghost ghost commented May 3, 2018

<3

@oinkbark

This comment has been minimized.

Copy link

@oinkbark oinkbark commented Jun 16, 2018

useless junk and fluff

@maximousblk

This comment has been minimized.

Copy link

@maximousblk maximousblk commented Jun 20, 2018

@ahmed-taj You are right. They just added the contribution and PR thing and renamed it!

@hearot

This comment has been minimized.

Copy link

@hearot hearot commented Jun 21, 2018

❤️

@learn2mine

This comment has been minimized.

Copy link

@learn2mine learn2mine commented Jul 11, 2018

I really like the first part of it... Thanks sooo much

@sb-01

This comment has been minimized.

Copy link

@sb-01 sb-01 commented Jul 15, 2018

<3

@Alexiades

This comment has been minimized.

Copy link

@Alexiades Alexiades commented Jul 29, 2018

Thanks !! Great job.

@thetinahang

This comment has been minimized.

Copy link

@thetinahang thetinahang commented Aug 6, 2018

Thank you! This was a great find!

@felexkemboi

This comment has been minimized.

Copy link

@felexkemboi felexkemboi commented Aug 9, 2018

Awesome

@maiararsensedia

This comment has been minimized.

Copy link

@maiararsensedia maiararsensedia commented Aug 9, 2018

Thanks <3

@Fuzzy-Logik

This comment has been minimized.

Copy link

@Fuzzy-Logik Fuzzy-Logik commented Aug 24, 2018

smh. This is a terrible guidelines template.

@PiSaucer

This comment has been minimized.

Copy link

@PiSaucer PiSaucer commented Sep 16, 2018

THANK YOU SO MUCH!!!

@rpavlik

This comment has been minimized.

Copy link

@rpavlik rpavlik commented Sep 28, 2018

Thanks for this! The code of conduct of course is from https://www.contributor-covenant.org/ and is CC-BY 4.0. Is there a license and attribution/copyright text for the rest of the this template, as well as the readme template (which I also found excellent and useful)? There's less text there that I'd leave intact - it's mostly the headings - and I of course mention the source in attributions, but I want to make sure I have my ducks in a row and have appropriate license and copyright notices. (Seems poor practice for me to publish a README that includes "all files shall include an SPDX-License-Identifier tag and a copyright notice" but that itself lacks those two elements 😉 )

@louise-r-blue

This comment has been minimized.

Copy link

@louise-r-blue louise-r-blue commented Sep 30, 2018

Thank you for sharing : }

@marcoah

This comment has been minimized.

Copy link

@marcoah marcoah commented Oct 9, 2018

Gracias por compartir!

@PerfectComputerSolutionsNP

This comment has been minimized.

Copy link

@PerfectComputerSolutionsNP PerfectComputerSolutionsNP commented Oct 17, 2018

Thanks! Great

@RoeyPrat

This comment has been minimized.

Copy link

@RoeyPrat RoeyPrat commented Nov 28, 2018

❤️ Thanks!

@DCtheTall

This comment has been minimized.

Copy link

@DCtheTall DCtheTall commented Nov 30, 2018

🎉

@ranndev

This comment has been minimized.

Copy link

@ranndev ranndev commented Dec 9, 2018

<3

@denwebler

This comment has been minimized.

Copy link

@denwebler denwebler commented Dec 16, 2018

Thanks Billie!:D

@githublemming

This comment has been minimized.

Copy link

@githublemming githublemming commented Dec 23, 2018

excellent

@dlanthier-youitv

This comment has been minimized.

Copy link

@dlanthier-youitv dlanthier-youitv commented Jan 8, 2019

❤️

@LukaszKokot

This comment has been minimized.

Copy link

@LukaszKokot LukaszKokot commented Jan 11, 2019

❤️

@ChathuraMalinga

This comment has been minimized.

Copy link

@ChathuraMalinga ChathuraMalinga commented Jan 30, 2019

Thank you ❤️❤️❤️❤️❤️❤️❤️

@fabiosantoscode

This comment has been minimized.

Copy link

@fabiosantoscode fabiosantoscode commented Feb 4, 2019

Thank you! This will be the Terser project CONTRIBUTING.md. With a link here!

@tubone24

This comment has been minimized.

Copy link

@tubone24 tubone24 commented Feb 7, 2019

Thanks! !

@Michu44

This comment has been minimized.

Copy link

@Michu44 Michu44 commented Feb 16, 2019

Thanks for the work put into this!

@sfauch1

This comment has been minimized.

Copy link

@sfauch1 sfauch1 commented Feb 23, 2019

Thanks

@nyurik

This comment has been minimized.

Copy link

@nyurik nyurik commented Mar 25, 2019

@PurpleBooth thanks, but could you add a license to that text? Ideally CC0 (public domain dedication), assuming you own the copyright to the whole work. It would not be right to use your template without knowing what license you published it under. Thanks!

@kalicki2k

This comment has been minimized.

Copy link

@kalicki2k kalicki2k commented May 11, 2019

Thanks <3

@Jacob-Stevens-Haas

This comment has been minimized.

Copy link

@Jacob-Stevens-Haas Jacob-Stevens-Haas commented May 13, 2019

❤️

@antonlima

This comment has been minimized.

Copy link

@antonlima antonlima commented May 17, 2019

This is extremely helpful! Thanks!

@mchiasson

This comment has been minimized.

Copy link

@mchiasson mchiasson commented May 29, 2019

❤️

@enesacikoglu

This comment has been minimized.

Copy link

@enesacikoglu enesacikoglu commented Jun 3, 2019

❤️

@SimiCode

This comment has been minimized.

Copy link

@SimiCode SimiCode commented Jun 14, 2019

red heart emoji

@channprj

This comment has been minimized.

Copy link

@channprj channprj commented Jun 17, 2019

❤️

@YogliB

This comment has been minimized.

Copy link

@YogliB YogliB commented Jun 17, 2019

Thanks!

@leodecm3

This comment has been minimized.

Copy link

@leodecm3 leodecm3 commented Jul 6, 2019

thanks

@mi2428

This comment has been minimized.

Copy link

@mi2428 mi2428 commented Jul 27, 2019

❤️

@istiyakaminsanto

This comment has been minimized.

Copy link

@istiyakaminsanto istiyakaminsanto commented Aug 4, 2019

Love you brother <3

@chowmean

This comment has been minimized.

Copy link

@chowmean chowmean commented Aug 18, 2019

❤️

@israelcena

This comment has been minimized.

Copy link

@israelcena israelcena commented Aug 21, 2019

❤️

@squidfarts

This comment has been minimized.

Copy link

@squidfarts squidfarts commented Aug 23, 2019

👍

@IlyaBkmz

This comment has been minimized.

Copy link

@IlyaBkmz IlyaBkmz commented Sep 2, 2019

Really cool!

@metablaster

This comment has been minimized.

Copy link

@metablaster metablaster commented Sep 23, 2019

Very good! 🥇

already copying... :D

@bthoven

This comment has been minimized.

Copy link

@bthoven bthoven commented Oct 17, 2019

Thanks

@Classy-Bear

This comment has been minimized.

Copy link

@Classy-Bear Classy-Bear commented Oct 29, 2019

❤️

@ExtensionShoe

This comment has been minimized.

Copy link

@ExtensionShoe ExtensionShoe commented Jan 19, 2020

@GypsyTheDj

This comment has been minimized.

Copy link

@GypsyTheDj GypsyTheDj commented Jan 22, 2020

With Love ❤️

@Allan-Nava

This comment has been minimized.

Copy link

@Allan-Nava Allan-Nava commented Jan 27, 2020

thanks!

@antonvinceguinto

This comment has been minimized.

Copy link

@antonvinceguinto antonvinceguinto commented Jan 31, 2020

Thank you

@dwasyluk

This comment has been minimized.

Copy link

@dwasyluk dwasyluk commented Feb 13, 2020

Thanks!

@GypsyTheDj

This comment has been minimized.

@PurpleBooth

This comment has been minimized.

Copy link
Owner Author

@PurpleBooth PurpleBooth commented Feb 13, 2020

An alternative that I like a lot more now:

Contributing

Issues

Issues are very valuable to this project.

  • Ideas are a valuable source of contributions others can make
  • Problems show where this project is lacking
  • With a question you show where contributors can improve the user experience

Thank you for creating them.

Pull Requests

Pull requests are, a great way to get your ideas into this repository.

When deciding if I merge in a pull request I look at the following things:

Does it state intent

You should be clear which problem you're trying to solve with your contribution.

For example:

Add link to code of conduct in README.md

Doesn't tell me anything about why you're doing that

Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.

Is it of good quality

  • There are no spelling mistakes
  • It reads well
  • For english language contributions: Has a good score on Grammarly or Hemingway App

Does it move this repository closer to my vision for the repository

The aim of this repository is:

  • To provide a README.md and assorted documents anyone can copy and paste, into their project
  • The content is usable by someone who hasn't written something like this before
  • Foster a culture of respect and gratitude in the open source community.

Does it follow the contributor covenant

This repository has a code of conduct, This repository has a code of conduct, I will remove things that do not respect it.

# Contributing

## Issues

Issues are very valuable to this project.

* Ideas are a valuable source of contributions others can make
* Problems show where this project is lacking
* With a question you show where contributors can improve the user experience

Thank you for creating them.

## Pull Requests

Pull requests are, a great way to get your ideas into this repository.

When deciding if I merge in a pull request I look at the following things:

### Does it state intent

You should be clear which problem you're trying to solve with your contribution.

For example:

> Add link to code of conduct in README.md

Doesn't tell me anything about why you're doing that

> Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.


### Is it of good quality

* There are no spelling mistakes
* It reads well
* For english language contributions: Has a good score on [Grammarly](grammarly.com) or [Hemingway App](http://www.hemingwayapp.com/)

### Does it move this repository closer to my vision for the repository

The aim of this repository is:

* To provide a README.md and assorted documents anyone can copy and paste, into their project
* The content is usable by someone who hasn't written something like this before
* Foster a culture of respect and gratitude in the open source community.

### Does it follow the contributor covenant

This repository has a [code of conduct](CODE_OF_CONDUCT.md), This repository has a code of conduct, I will remove things that do not respect it.
@PurpleBooth

This comment has been minimized.

Copy link
Owner Author

@PurpleBooth PurpleBooth commented Feb 13, 2020

I want to call out that a large portion of the one in the main text block is from the contributor-covenant. Someone mentioned it in an earlier comment.

I don't feel that's obvious enough and they deserve that credit.

License wise see, but like, lets be honest here, I am not going to sue you if you ignore it. If you're worried drop me an message somehow and I'll give you explicit permission

@GypsyTheDj

This comment has been minimized.

Copy link

@GypsyTheDj GypsyTheDj commented Feb 13, 2020

@cahyoari89

This comment has been minimized.

Copy link

@cahyoari89 cahyoari89 commented Mar 12, 2020

hi, nice, but i am newbe, dont know how to using, upload in sever etc.. can u detail show me?

@yangwao

This comment has been minimized.

Copy link

@yangwao yangwao commented Mar 20, 2020

@PurpleBooth thanks for update! Just using it for our OSS project too! :)

@ElCosmoXD

This comment has been minimized.

Copy link

@ElCosmoXD ElCosmoXD commented Mar 23, 2020

THANKS.

@jerseysu

This comment has been minimized.

Copy link

@jerseysu jerseysu commented Mar 28, 2020

Thanks!

@marlonlom

This comment has been minimized.

Copy link

@marlonlom marlonlom commented Apr 27, 2020

Thanks a a lot. it is very useful in starter and advanced projects/ repositories @PurpleBooth :D

@alfredoh1234

This comment has been minimized.

Copy link

@alfredoh1234 alfredoh1234 commented May 13, 2020

Thanks for sharing, Will start from it for our Open Source Hardware project: https://opensource.ieee.org/ieee-ottawa-sight/uv-light-example/

@mrashad10

This comment has been minimized.

Copy link

@mrashad10 mrashad10 commented May 16, 2020

Thanks again

@Mixel2142

This comment has been minimized.

Copy link

@Mixel2142 Mixel2142 commented May 18, 2020

Thanks!

@HolimaX

This comment has been minimized.

Copy link

@HolimaX HolimaX commented May 20, 2020

So, if the repo code is used to produce an item/object, that is also protected with trademark, I cannot use these two templates??? What a crap...

@metablaster

This comment has been minimized.

Copy link

@metablaster metablaster commented May 21, 2020

that is also protected with trademark

What trademark are you talking about??
All you have to do is copy/paste this stuff and use it, and if you find it useful thank the author.

Alternatively you can get your own copy on below link and do modifications however you like:
https://www.contributor-covenant.org/version/1/4/code-of-conduct/

@nobody5050

This comment has been minimized.

Copy link

@nobody5050 nobody5050 commented May 26, 2020

This is epic, thanks!

@langyo

This comment has been minimized.

Copy link

@langyo langyo commented May 28, 2020

thx!

@miguelsosa19

This comment has been minimized.

Copy link

@miguelsosa19 miguelsosa19 commented Jun 8, 2020

How can I request to add the provider Huawei Cloud?

@hspedro

This comment has been minimized.

Copy link

@hspedro hspedro commented Jun 18, 2020

Thank You 💯 ❤️

@jcranston

This comment has been minimized.

Copy link

@jcranston jcranston commented Jun 22, 2020

♥️

@Garados007

This comment has been minimized.

Copy link

@Garados007 Garados007 commented Jul 19, 2020

❤️

@franklaercio

This comment has been minimized.

Copy link

@franklaercio franklaercio commented Jul 26, 2020

❤️

@dvm-shlee

This comment has been minimized.

Copy link

@dvm-shlee dvm-shlee commented Jul 31, 2020

This is a really good example! Thank you so much for sharing this!

@hex22a

This comment has been minimized.

Copy link

@hex22a hex22a commented Aug 2, 2020

👍 thx, it's a good example. I'll use some of it for my my project's contributing.md if you don't mind 😅

@VishwasShashidhar

This comment has been minimized.

Copy link

@VishwasShashidhar VishwasShashidhar commented Aug 14, 2020

❤️

@chexia159

This comment has been minimized.

Copy link

@chexia159 chexia159 commented Aug 28, 2020

Many thanks!

@Svastikkka

This comment has been minimized.

Copy link

@Svastikkka Svastikkka commented Sep 16, 2020

thanks @PurpleBooth

@kylebegovich

This comment has been minimized.

Copy link

@kylebegovich kylebegovich commented Sep 20, 2020

Thanks all! ❤️

@amitkrishna

This comment has been minimized.

Copy link

@amitkrishna amitkrishna commented Sep 30, 2020

❤️

@ProgrammerSnigdho

This comment has been minimized.

Copy link

@ProgrammerSnigdho ProgrammerSnigdho commented Oct 3, 2020

print('Dislike World')

@iiprodakts

This comment has been minimized.

Copy link

@iiprodakts iiprodakts commented Oct 5, 2020

Ha khensa (We thank you) PurpleBooth, this is a nicely laid out document.

@perpouh

This comment has been minimized.

Copy link

@perpouh perpouh commented Oct 8, 2020

<3!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.