From ade0dc447e21082f7ac6ae21ec4896954c607e7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Borbo=C3=ABn?= Date: Tue, 7 Aug 2018 14:27:11 +0200 Subject: [PATCH 1/4] Code of conduct added * Based on contributor-covenant.org --- CODE-OF-CONDUCT | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 CODE-OF-CONDUCT diff --git a/CODE-OF-CONDUCT b/CODE-OF-CONDUCT new file mode 100644 index 000000000..308f11a15 --- /dev/null +++ b/CODE-OF-CONDUCT @@ -0,0 +1,74 @@ +# Contributor Covenant 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, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, 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 leader](https://github.com/jesseduffield). +All complaints will be reviewed and investigated and will result in a response that +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][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org From a6cb0feff18bfcea9f0473485cf788ddd3ee5834 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Borbo=C3=ABn?= Date: Tue, 7 Aug 2018 14:28:52 +0200 Subject: [PATCH 2/4] Contributing guide added This is a mix between * https://gist.github.com/PurpleBooth/b24679402957c63ec426 * https://github.com/thoughtbot/factory_bot_rails/blob/master/CONTRIBUTING.md * https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62 * https://github.com/nayafia/contributing-template --- CONTRIBUTING | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 000000000..ec666985d --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,34 @@ +# Contributing + + +♥ We love pull requests from everyone ! + + +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. + +## So all code changes happen through Pull Requests +Pull requests are the best way to propose changes to the codebase. We actively +welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've added code that need documentation, update the documentation. +4. Be sure to test your modifications. +5. Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +6. Issue that pull request! + +## Code of conduct +Please note by participating in this project, you agree to abide by the [code of conduct]. + +[code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING + +## Any contributions you make will be under the MIT Software License +In short, when you submit code changes, your submissions are understood to be +under the same [MIT License](http://choosealicense.com/licenses/mit/) that +covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using Github's [issues](https://github.com/jesseduffield/lazygit/issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new +issue](https://github.com/jesseduffield/lazygit/issues/new); it's that easy! \ No newline at end of file From cda365a93f9c8bd50965806261e95e1f6a0006ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Borbo=C3=ABn?= Date: Tue, 7 Aug 2018 14:32:04 +0200 Subject: [PATCH 3/4] Contributing guide proposal --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fcd651684..df99c4a6f 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ sudo apt-get install lazygit - [ ] i18n ## Contributing -I'll find a good template for contributing and then add it to the repo (or if somebody has a suggestion please put up a PR) +We love your input! Please check out the [contributing guide](CONTRIBUTING). ## Work in progress This is still a work in progress so there's still bugs to iron out and as this is my first project in Go the code could no doubt use an increase in quality, but I'll be improving on it whenever I find the time. If you have any feedback feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls). From 2311675d087bbbfbf791895c43561eebc1f6279e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Borbo=C3=ABn?= Date: Tue, 7 Aug 2018 14:37:35 +0200 Subject: [PATCH 4/4] It appears that markdown files are better handeled by GitHub with extensions. --- CODE-OF-CONDUCT => CODE-OF-CONDUCT.md | 0 CONTRIBUTING => CONTRIBUTING.md | 2 +- README.md | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename CODE-OF-CONDUCT => CODE-OF-CONDUCT.md (100%) rename CONTRIBUTING => CONTRIBUTING.md (98%) diff --git a/CODE-OF-CONDUCT b/CODE-OF-CONDUCT.md similarity index 100% rename from CODE-OF-CONDUCT rename to CODE-OF-CONDUCT.md diff --git a/CONTRIBUTING b/CONTRIBUTING.md similarity index 98% rename from CONTRIBUTING rename to CONTRIBUTING.md index ec666985d..e28913f44 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ welcome your pull requests: ## Code of conduct Please note by participating in this project, you agree to abide by the [code of conduct]. -[code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING +[code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md ## Any contributions you make will be under the MIT Software License In short, when you submit code changes, your submissions are understood to be diff --git a/README.md b/README.md index df99c4a6f..1ac741768 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ sudo apt-get install lazygit - [ ] i18n ## Contributing -We love your input! Please check out the [contributing guide](CONTRIBUTING). +We love your input! Please check out the [contributing guide](CONTRIBUTING.md). ## Work in progress This is still a work in progress so there's still bugs to iron out and as this is my first project in Go the code could no doubt use an increase in quality, but I'll be improving on it whenever I find the time. If you have any feedback feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).