Skip to content

Commit 40746a5

Browse files
hbulenshbulens
committed
Contribution guide & license
1 parent 31cefc3 commit 40746a5

File tree

3 files changed

+299
-0
lines changed

3 files changed

+299
-0
lines changed

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# Contributing
2+
3+
Here are the guidelines we'd like you to follow:
4+
5+
- [Contributing](#contributing)
6+
- [Code of Conduct](#code-of-conduct)
7+
- [Semantic Versioning](#semantic-versioning)
8+
- [Questions, Bugs, Features](#questions-bugs-features)
9+
- [Questions](#questions)
10+
- [Bugs](#bugs)
11+
- [Features](#features)
12+
- [Issue Submission Guidelines](#issue-submission-guidelines)
13+
- [Pull request Submission Guidelines](#pull-request-submission-guidelines)
14+
- [After your pull request is merged](#after-your-pull-request-is-merged)
15+
16+
Make sure to comply with the [code of conduct](CODE_OF_CONDUCT.md).
17+
18+
## Code of Conduct
19+
20+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
21+
22+
Dime has adopted the [Contributor Covenant](./CODE_OF_CONDUCT.md) as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
23+
24+
## Semantic Versioning
25+
26+
Dime follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
27+
28+
## Questions, Bugs, Features
29+
30+
### Questions
31+
32+
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on dedicated support platforms, the best being [Stack Overflow][stackoverflow].
33+
34+
### Bugs
35+
36+
If you find a bug in the source code, you can help us by submitting an issue to our
37+
GitHub repository. Even better, you can submit a pull request with a fix.
38+
39+
Please see the [submission guidelines](#issue-submission-guidelines) below.
40+
41+
### Features
42+
43+
You can request a new feature by submitting an issue to our GitHub repository.
44+
45+
If you would like to implement a new feature then consider what kind of change it is:
46+
47+
* **Major Changes** that you wish to contribute to the project should be discussed first in an issue that clearly outlines the changes and benefits of the feature.
48+
* **Small Changes** can directly be crafted and submitted to the GitHub repository
49+
as a pull request. See the section about [pull request submission guidelines](#submit-pr).
50+
51+
## Issue Submission Guidelines
52+
53+
Before you submit your issue search the archive, maybe your question was already answered.
54+
55+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. The new issue form contains a number of prompts that you should fill out to
56+
make it easier to understand and categorize the issue.
57+
58+
In general, providing the following information will increase the chances of your issue being dealt with quickly:
59+
60+
- **Overview of the issue**: if an error is being thrown a non-minified stack trace helps
61+
- **Motivation for or use case**: explain why this is a bug for you
62+
- **Version(s)**: is it a regression?
63+
- **Browsers and/or operating system**:is this a problem with all browsers or only specific ones?
64+
- **Reproduce the error**: provide a live example or an unambiguous set of steps.
65+
- **Related issues**: has a similar issue been reported before?
66+
- **Suggest a Fix**: if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
67+
68+
## Pull request Submission Guidelines
69+
70+
Before you submit your pull request consider the following guidelines:
71+
72+
- Search GitHub for an open or closed pull request that relates to your submission. You don't want to duplicate effort.
73+
- Create the development environment
74+
- Make your changes in a new git branch:
75+
76+
```shell
77+
git checkout -b my-fix-branch master
78+
```
79+
80+
- Create your patch commit, **including appropriate test cases**.
81+
- Follow the coding rules.
82+
- If the changes affect public APIs, change or add relevant documentation.
83+
- Run the test suites, and ensure that all tests pass.
84+
- Commit your changes using a descriptive commit message that follows the commit message convention.
85+
86+
```shell
87+
git commit -a
88+
```
89+
90+
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
91+
92+
- Before creating the pull request, package and run all tests a last time.
93+
- Push your branch to GitHub:
94+
95+
```shell
96+
git push origin my-fix-branch
97+
```
98+
99+
- In GitHub, send a pull request to the master branch.
100+
101+
- If you find that the continuous integration tests have failed, look into the logs to find out if your changes caused test failures, the commit message was malformed etc. If you find that the tests failed or times out for unrelated reasons, you can ping a team member so that the build can be restarted.
102+
103+
- If we suggest changes, then:
104+
105+
- Make the required updates.
106+
- Re-run the test suite to ensure tests are still passing.
107+
- Commit your changes to your branch (e.g. `my-fix-branch`).
108+
- Push the changes to your GitHub repository (this will update your pull request).
109+
110+
You can also amend the initial commits and force push them to the branch.
111+
112+
```shell
113+
git rebase master -i
114+
git push origin my-fix-branch -f
115+
```
116+
117+
This is generally easier to follow, but separate commits are useful if the pull request contains iterations that might be interesting to see side-by-side.
118+
119+
That's it! Thank you for your contribution!
120+
121+
### After your pull request is merged
122+
123+
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
124+
125+
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
126+
127+
```shell
128+
git push origin --delete my-fix-branch
129+
```
130+
131+
- Check out the master branch:
132+
133+
```shell
134+
git checkout master -f
135+
```
136+
137+
- Delete the local branch:
138+
139+
```shell
140+
git branch -D my-fix-branch
141+
```
142+
143+
- Update your master with the latest upstream version:
144+
145+
```shell
146+
git pull --ff upstream master
147+
```
148+
149+
[stackoverflow]: http://stackoverflow.com

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Dimenics
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)