Skip to content

Commit 1a0a9ef

Browse files
author
Ricky White
authored
Add template files and contribution guide. (#43)
* Add Issue and PR templates * Add contributing.md * Add code of conduct * Fixed Typos * Link the contributing guide in the readme.
1 parent 72e1e35 commit 1a0a9ef

File tree

6 files changed

+281
-0
lines changed

6 files changed

+281
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Keeper Security Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].

‎.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: For reporting bugs and other general issues.
4+
---
5+
6+
**Description of the issue**
7+
8+
Describe your issue here.
9+
10+
**Expected behavior**
11+
12+
Tell us what _should_ happen
13+
14+
**Actual behavior**
15+
16+
Tell us what _actually_ happens
17+
18+
**Your environment**
19+
20+
Tell us more about your environment; such as, What OS are you running? What version of `git-ssh-sign` are you using? Etc.
21+
22+
**Steps to reproduce**
23+
24+
Tell us how to reproduce this issue. Please include code examples as necessary.

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: If you have a feature or enhancement request
4+
---
5+
6+
## Feature / Enhancement proposed
7+
8+
_What capability would you like to add? Is it something you currently you cannot do? Is this related to an issue/problem?_
9+
10+
## Workarounds
11+
12+
Can you achieve the same result doing it in an alternative way?
13+
14+
## Has the feature been requested before?
15+
16+
_If yes, Please provide a link to relevant issues and PRs._
17+
18+
## If the feature request is approved, would you be willing to submit a PR?
19+
20+
_(Help can be provided if you need assistance submitting a PR)_
21+
22+
[] Yes [] No

‎.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Pull request
3+
about: If you have a pull request to fix a bug or add a feature
4+
---
5+
6+
## Pull request checklist
7+
8+
Please check if your PR fulfills the following requirements:
9+
10+
- [ ] You have read the contributing guide
11+
- [ ] Tests for the changes have been added
12+
- [ ] The documentation has been reviewed and updated as needed
13+
14+
## What is the current behavior?
15+
16+
_Please describe the current behavior that you are modifying, and link its a relevant issue_
17+
18+
Issue Number: _Add the issue number this PR address here._
19+
20+
## What is the new behavior?
21+
22+
-
23+
-
24+
-
25+
26+
## Does this introduce a breaking change?
27+
28+
- [ ] Yes
29+
- [ ] No
30+
31+
**If yes, please describe...**
32+
33+
## Other relevant information
34+
35+
_e.g. does this PR require another PR to be merged first?_

‎CONTRIBUTING.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to Git-SSH-Sign
2+
3+
Thank you for considering contributing to `git-ssh-sign`! We welcome contributions from the community and appreciate your help in making this project better. Before you start contributing, please take a moment to read the following guidelines.
4+
5+
## Table of Contents
6+
7+
- [Contributing to Git-SSH-Sign](#contributing-to-git-ssh-sign)
8+
- [Table of Contents](#table-of-contents)
9+
- [Code of Conduct](#code-of-conduct)
10+
- [Getting Started](#getting-started)
11+
- [How to Contribute](#how-to-contribute)
12+
- [Pull Request Guidelines](#pull-request-guidelines)
13+
- [Reporting Bugs](#reporting-bugs)
14+
- [Feature Requests](#feature-requests)
15+
- [License](#license)
16+
17+
## Code of Conduct
18+
19+
We have adopted a Code of Conduct that we expect project participants to adhere to. Please read [CODE_OF_CONDUCT.md](https://github.com/Keeper-Security/git-ssh-sign/tree/main/.github/CODE_OF_CONDUCT.md) for details.
20+
21+
## Getting Started
22+
23+
Before you begin contributing, you should:
24+
25+
- [Fork the repository](https://github.com/keeper-security/git-ssh-sign/fork)
26+
- Clone the forked repository to your local machine
27+
- Create a new branch for your work
28+
- Review the project's documentation to understand its architecture and guidelines
29+
- Optional (but encouraged): Star the project
30+
31+
## How to Contribute
32+
33+
Here are some ways you can contribute to this project:
34+
35+
- Reporting bugs
36+
- Suggesting new features
37+
- Writing code
38+
- Improving documentation
39+
- Providing feedback / Ask questions
40+
41+
Please ensure that your contributions align with the project's goals and follow the guidelines below.
42+
43+
## Pull Request Guidelines
44+
45+
Before creating a pull request (PR), please ensure you create an issue first, if one does not already exist. This achieves two things:
46+
47+
1. It ensures technical decisions that need to be made can be discussed *before* you start writing code, leading to less refactoring and change requests before merging your code.
48+
2. It ensures the bug or feature you are contributing to is documented showing other contributors that this bug/feature is being worked on, avoiding the unfortunate problem of having more than one PR for the same bug/feature.
49+
50+
To get started on your PR:
51+
52+
- Fork the repository and create a new branch.
53+
- Make sure your code follows the project's coding style and conventions.
54+
- Write clear and concise commit messages.
55+
- Test your changes thoroughly.
56+
- Update the documentation if necessary.
57+
- Submit a pull request, explaining the purpose of the changes and any relevant information.
58+
59+
## Reporting Bugs
60+
61+
If you find a bug or issue in the project, please report it using the [Issue Tracker](https://github.com/Keeper-Security/git-ssh-sign/issues). Please fill in all the required information in the provided template to the best of your abiliy, including a detailed description of the problem and steps to reproduce it.
62+
63+
## Feature Requests
64+
65+
If you have an idea for a new feature or improvement, please open an issue in the [Issue Tracker](https://github.com/Keeper-Security/git-ssh-sign/issues) and use the "feature request" template provided. Describe the proposed feature and its benefits.
66+
67+
68+
## License
69+
70+
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file of this repository.
71+
72+
Thank you for your interest in `git-ssh-sign`! We look forward to your contributions.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ rIalDYl8KKK+DPrwiF4KCKoovNN2xXu04ljxLH9O3byUcA==
181181

182182
## Contributing
183183

184+
Please read and refer to the [contribution guide](https://github.com/Keeper-Security/git-ssh-sign/blob/main/CONTRIBUTING.md) before making your first PR.
185+
184186
This module uses the built-in Golang tooling for building and testing:
185187

186188
```shell

0 commit comments

Comments
 (0)