Skip to content

Commit aa6a0bd

Browse files
committed
2 parents d781a8e + dd6cdc0 commit aa6a0bd

File tree

3 files changed

+109
-1
lines changed

3 files changed

+109
-1
lines changed

CODE-OF-CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the [project leader](https://github.com/jesseduffield).
59+
All complaints will be reviewed and investigated and will result in a response that
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
4+
♥ We love pull requests from everyone !
5+
6+
7+
When contributing to this repository, please first discuss the change you wish
8+
to make via issue, email, or any other method with the owners of this repository
9+
before making a change.
10+
11+
## So all code changes happen through Pull Requests
12+
Pull requests are the best way to propose changes to the codebase. We actively
13+
welcome your pull requests:
14+
15+
1. Fork the repo and create your branch from `master`.
16+
2. If you've added code that should be tested, add tests.
17+
3. If you've added code that need documentation, update the documentation.
18+
4. Be sure to test your modifications.
19+
5. Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
20+
6. Issue that pull request!
21+
22+
## Code of conduct
23+
Please note by participating in this project, you agree to abide by the [code of conduct].
24+
25+
[code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md
26+
27+
## Any contributions you make will be under the MIT Software License
28+
In short, when you submit code changes, your submissions are understood to be
29+
under the same [MIT License](http://choosealicense.com/licenses/mit/) that
30+
covers the project. Feel free to contact the maintainers if that's a concern.
31+
32+
## Report bugs using Github's [issues](https://github.com/jesseduffield/lazygit/issues)
33+
We use GitHub issues to track public bugs. Report a bug by [opening a new
34+
issue](https://github.com/jesseduffield/lazygit/issues/new); it's that easy!

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ sudo apt-get install lazygit
5757
- [ ] i18n
5858

5959
## Contributing
60-
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)
60+
We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
6161

6262
## Work in progress
6363
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).

0 commit comments

Comments
 (0)