Skip to content
This repository was archived by the owner on Oct 9, 2019. It is now read-only.

Commit 9ea6f9f

Browse files
committed
.
Signed-off-by: Yoshua Wuyts <[email protected]>
0 parents  commit 9ea6f9f

19 files changed

+785
-0
lines changed

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing
2+
Contributions include code, documentation, answering user questions, running the
3+
project's infrastructure, and advocating for all types of users.
4+
5+
The project welcomes all contributions from anyone willing to work in good faith
6+
with other contributors and the community. No contribution is too small and all
7+
contributions are valued.
8+
9+
This guide explains the process for contributing to the project's GitHub
10+
Repository.
11+
12+
- [Code of Conduct](#code-of-conduct)
13+
- [Bad Actors](#bad-actors)
14+
- [Developer Certificate of Origin](#developer-certificate-of-origin)
15+
16+
## Code of Conduct
17+
The project has a [Code of Conduct](./CODE_OF_CONDUCT.md) that *all*
18+
contributors are expected to follow. This code describes the *minimum* behavior
19+
expectations for all contributors.
20+
21+
As a contributor, how you choose to act and interact towards your
22+
fellow contributors, as well as to the community, will reflect back not only
23+
on yourself but on the project as a whole. The Code of Conduct is designed and
24+
intended, above all else, to help establish a culture within the project that
25+
allows anyone and everyone who wants to contribute to feel safe doing so.
26+
27+
Should any individual act in any way that is considered in violation of the
28+
[Code of Conduct](./CODE_OF_CONDUCT.md), corrective actions will be taken. It is
29+
possible, however, for any individual to *act* in such a manner that is not in
30+
violation of the strict letter of the Code of Conduct guidelines while still
31+
going completely against the spirit of what that Code is intended to accomplish.
32+
33+
Open, diverse, and inclusive communities live and die on the basis of trust.
34+
Contributors can disagree with one another so long as they trust that those
35+
disagreements are in good faith and everyone is working towards a common
36+
goal.
37+
38+
## Bad Actors
39+
All contributors to tacitly agree to abide by both the letter and
40+
spirit of the [Code of Conduct](./CODE_OF_CONDUCT.md). Failure, or
41+
unwillingness, to do so will result in contributions being respectfully
42+
declined.
43+
44+
A *bad actor* is someone who repeatedly violates the *spirit* of the Code of
45+
Conduct through consistent failure to self-regulate the way in which they
46+
interact with other contributors in the project. In doing so, bad actors
47+
alienate other contributors, discourage collaboration, and generally reflect
48+
poorly on the project as a whole.
49+
50+
Being a bad actor may be intentional or unintentional. Typically, unintentional
51+
bad behavior can be easily corrected by being quick to apologize and correct
52+
course *even if you are not entirely convinced you need to*. Giving other
53+
contributors the benefit of the doubt and having a sincere willingness to admit
54+
that you *might* be wrong is critical for any successful open collaboration.
55+
56+
Don't be a bad actor.
57+
58+
## Developer Certificate of Origin
59+
All contributors must read and agree to the [Developer Certificate of
60+
Origin (DCO)](../CERTIFICATE).
61+
62+
The DCO allows us to accept contributions from people to the project, similarly
63+
to how a license allows us to distribute our code.

.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Summary
2+
Explain what is going on.
3+
4+
## Your Environment
5+
| Software | Version(s) |
6+
| ---------------- | ---------- |
7+
| ready |
8+
| Rustc |
9+
| Operating System |

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug Report
3+
about: Did something not work as expected?
4+
---
5+
6+
# Bug Report
7+
## Your Environment
8+
| Software | Version(s) |
9+
| ---------------- | ---------- |
10+
| ready |
11+
| Rustc |
12+
| Operating System |
13+
14+
## Expected Behavior
15+
Tell us what should have happened.
16+
17+
## Current Behavior
18+
Tell us what happens instead of the expected behavior. If you are seeing an
19+
error, please include the full error message and stack trace.
20+
21+
## Code Sample
22+
Please provide a code repository, gist, code snippet or sample files to
23+
reproduce the issue.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Feature Request
3+
about: Want us to add something to ready?
4+
---
5+
6+
# Feature Request
7+
## Summary
8+
One paragraph explanation of the feature.
9+
10+
## Motivation
11+
Why are we doing this? What use cases does it support? What is the expected
12+
outcome?
13+
14+
## Guide-level explanation
15+
Explain the proposal as if it was already included in the project and you
16+
were teaching it to another programmer. That generally means:
17+
18+
- Introducing new named concepts.
19+
- Explaining the feature largely in terms of examples.
20+
- If applicable, provide sample error messages, deprecation warnings, or
21+
migration guidance.
22+
23+
## Reference-level explanation
24+
This is the technical portion of the feature request. Explain the design in
25+
sufficient detail that:
26+
27+
- Its interaction with other features is clear.
28+
- It is reasonably clear how the feature would be implemented.
29+
- Corner cases are dissected by example.
30+
31+
## Drawbacks
32+
Why should we _not_ do this?
33+
34+
## Rationale and alternatives
35+
- Why is this design the best in the space of possible designs?
36+
- What other designs have been considered and what is the rationale for not
37+
choosing them?
38+
- What is the impact of not doing this?
39+
40+
## Unresolved Questions
41+
What related issues do you consider out of scope for this feature that could be
42+
addressed in the future independently of the solution that comes out of this
43+
feature?

.github/ISSUE_TEMPLATE/question.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Question
3+
about: Have any questions regarding how ready works?
4+
---
5+
6+
# Question
7+
## Your Environment
8+
| Software | Version(s) |
9+
| ---------------- | ---------- |
10+
| ready |
11+
| Rustc |
12+
| Operating System |
13+
14+
## Question
15+
Provide your question here.
16+
17+
## Context
18+
How has this issue affected you? What are you trying to accomplish?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
Thanks for creating a Pull Request 😄 ! Before you submit, please read the following:
3+
- Read our CONTRIBUTING.md file before submitting a patch.
4+
- By making a contribution, you agree to our Developer Certificate of Origin.
5+
-->
6+
7+
**Choose one:** is this a 🐛 bug fix, a 🙋 feature, or a 🔦 documentation change?
8+
9+
<!-- Provide a general summary of the changes in the title above -->
10+
11+
## Checklist
12+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
13+
- [ ] tests pass
14+
- [ ] tests and/or benchmarks are included
15+
- [ ] documentation is changed or added
16+
17+
## Context
18+
<!-- Is this related to any GitHub issue(s)? -->
19+
20+
## Semver Changes
21+
<!-- Which semantic version change would you recommend? -->

.github/stale.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
daysUntilStale: 90
4+
daysUntilClose: 7
5+
exemptLabels:
6+
- pinned
7+
- security
8+
exemptProjects: false
9+
exemptMilestones: false
10+
staleLabel: wontfix
11+
markComment: >
12+
This issue has been automatically marked as stale because it has not had
13+
recent activity. It will be closed if no further activity occurs. Thank you
14+
for your contributions.
15+
unmarkComment: false
16+
closeComment: false
17+
limitPerRun: 30

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
coverage/
2+
target/
3+
tmp/
4+
dist/
5+
npm-debug.log*
6+
Cargo.lock
7+
.DS_Store

.travis.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
language: rust
2+
rust:
3+
- stable
4+
5+
before_script: |
6+
rustup component add rustfmt-preview &&
7+
rustup component add clippy-preview
8+
script: |
9+
cargo fmt -- --check &&
10+
cargo clippy -- -D clippy &&
11+
cargo build --verbose &&
12+
cargo test --verbose
13+
cache: cargo

0 commit comments

Comments
 (0)