Skip to content

Commit 3f9ba24

Browse files
Empty2k12Empty2k12
authored
Contributing Guidelines, Code of Conduct and Issue Templates (#18)
* Write out Contributing Guidelines, adopt Code of Conduct and Issue Templates
1 parent fa4fb47 commit 3f9ba24

File tree

5 files changed

+267
-2
lines changed

5 files changed

+267
-2
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Bug report
3+
about: Report a problem with the library
4+
---
5+
6+
<!-- Please search existing issues and link prior issues if they're closed. -->
7+
8+
- Rust Version:
9+
- Runtime version (e.g. Tokio):
10+
- OS Version:
11+
12+
Steps to Reproduce:
13+
14+
1. 2.

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
<!-- Please search existing issues to avoid creating duplicates. If it exists, is closed, and -->
7+
<!-- you think it should be an issue, please link the old issue and state further arguments -->
8+
9+
<!-- Describe the feature you'd like. -->
10+
11+
<!-- How could your feature be implemented? -->

Diff for: ‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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 make 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 within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be 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 team at [[email protected]](mailto:[email protected]). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

Diff for: ‎CONTRIBUTING.md

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# Contributing to influxdb-rust
2+
3+
Thank you for contributing. It's much apprechiated!
4+
5+
The following is a set of guidelines for contributing to influxdb-rust, which is hosted at [Empty2k12/influxdb-rust](https://github.com/Empty2k12/influxdb-rust) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
#### Table Of Contents
8+
9+
[Code of Conduct](#code-of-conduct)
10+
11+
[How Can I Contribute?](#how-can-i-contribute)
12+
13+
- [Reporting Bugs](#reporting-bugs)
14+
- [Suggesting Enhancements](#suggesting-enhancements)
15+
- [Your First Code Contribution](#your-first-code-contribution)
16+
- [Pull Requests](#pull-requests)
17+
18+
[Styleguides](#styleguides)
19+
20+
- [Git Commit Messages](#git-commit-messages)
21+
- [Rust Styleguide](#rust-styleguide)
22+
23+
[Additional Notes](#additional-notes)
24+
25+
- [Issue and Pull Request Labels](#issue-and-pull-request-labels)
26+
27+
## Code of Conduct
28+
29+
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
30+
31+
## How Can I Contribute?
32+
33+
### Reporting Bugs
34+
35+
Please search the closed issues list before opening a bug report. If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
36+
37+
#### How Do I Submit A (Good) Bug Report?
38+
39+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Please fill out the bug report template when filing a bug.
40+
41+
Explain the problem and include additional details to help maintainers reproduce the problem:
42+
43+
- **Use a clear and descriptive title** for the issue to identify the problem.
44+
- **Describe the exact steps which reproduce the problem** in as many details as possible.
45+
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
46+
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
47+
- **Explain which behavior you expected to see instead and why.**
48+
49+
Provide more context by answering these questions:
50+
51+
- **Did the problem start happening recently** (e.g. after updating to a new version of influxdb-rust) or was this always a problem?
52+
- If the problem started happening recently, **can you reproduce the problem in an older version of influxdb-rust?** What's the most recent version in which the problem doesn't happen? You can download older versions of influxdb-rust from [the releases page](https://github.com/Empty2k12/influxdb-rust/releases).
53+
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
54+
55+
### Suggesting Enhancements
56+
57+
This section guides you through submitting an enhancement suggestion for influxdb-rust, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
58+
59+
When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the enhancement suggestion template, including the steps that you imagine you would take if the feature you're requesting existed.
60+
61+
#### How Do I Submit A (Good) Enhancement Suggestion?
62+
63+
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue and provide the following information:
64+
65+
- **Use a clear and descriptive title** for the issue to identify the suggestion.
66+
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
67+
- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
68+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
69+
- **Explain why this enhancement would be useful** to most influxdb-rust users.
70+
- **Specify the name and version of the OS you're using.**
71+
72+
### Your First Code Contribution
73+
74+
Unsure where to begin contributing to influxdb-rust? You can start by looking through these `good first issue` and `Type of Change: Minor` issues:
75+
76+
- [good first issue issues](https://github.com/Empty2k12/influxdb-rust/labels/good%20first%20issue) - issues which are suited for new developers. usually just some lines of code or just a test.
77+
- [Type of Change: Minor issues](https://github.com/Empty2k12/influxdb-rust/labels/Type%20of%20Change%3A%20Minor) - issues which only change a small amount of code in the library.
78+
- [Hacktoberfest issues](https://github.com/Empty2k12/influxdb-rust/labels/Hacktoberfest) - issues which are suited for someone taking part in Hacktoberfest.
79+
80+
#### Local development
81+
82+
influxdb-rust can be developed locally.
83+
84+
`cargo build` can be used to check if code is compiling. To run the integration tests, first start a InfluxDB docker container which the tests will run against using `docker run -d -p127.0.0.1:8086:8086 influxdb:alpine`. Once the container has started, you can run the integration tests using `cargo test`.
85+
86+
### Pull Requests
87+
88+
The process described here has several goals:
89+
90+
- Maintain influxdb-rust's quality
91+
- Fix problems that are important to users
92+
- Engage the community in working toward the best possible influxdb-rust
93+
- Enable a sustainable system for influxdb-rust's maintainers to review contributions
94+
95+
Please follow these steps to have your contribution considered by the maintainers:
96+
97+
1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
98+
2. Follow the [styleguides](#styleguides)
99+
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
100+
101+
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
102+
103+
## Styleguides
104+
105+
### Git Commit Messages
106+
107+
- Use the present tense ("Add feature" not "Added feature")
108+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
109+
- Limit the first line to 72 characters or less
110+
111+
### Rust Styleguide
112+
113+
Please format your code using `cargo fmt --all` and make sure `cargo clippy` produces no warnings.
114+
115+
## Additional Notes
116+
117+
### Issue and Pull Request Labels
118+
119+
This section lists the labels we use to help us track and manage issues and pull requests.
120+
121+
[GitHub search](https://help.github.com/articles/searching-issues/) makes it easy to use labels for finding groups of issues or pull requests you're interested in.
122+
123+
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
124+
125+
Please open an issue if you have suggestions for new labels.
126+
127+
#### Type of Issue or Pull Request
128+
129+
| Issue label | List issues | Description |
130+
| ------------------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
131+
| `Status: Merge when CI passes` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20merge%20when%20ci%20passes) | Applied when the pull request has been reviewed and is ready for merge once the CI pipeline passes. |
132+
| `Status: Awaiting Response` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20awaiting%20response) | Applied to issues which have a response from the issue owner pending. |
133+
| `Status: Pending Discussion` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20pending%20discussion) | Applied to pull requests where a pull request review has been submitted and the pull request author has not responded to feedback yet. |
134+
| `Status: Pending Updates` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Pending%20Updates) | Applied to pull requests where updates to the changeset is pending. |
135+
| `Status: Work in Progress` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Work%20in%20Progress) | Applied to pull requests that are work in progress. |
136+
137+
#### Type of Change of Issue or Pull Request
138+
139+
| Issue label | List issues | Description |
140+
| -------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
141+
| `Type: Bug` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Type%20Bug) | Applied to issues reporting bugs. |
142+
| `Type: Chore` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Type%20Chore) | Applied to issues and pull requests regarding miscellaneous tasks around the reposity. |
143+
| `Type: Enhancement` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Type%20Enhancement) | Applied to issues and pull requests where an existing feature is improved. |
144+
| `Type: Governance` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Status%3A%20Type%20Governance) | Applied to issues pull requests regarding repository governance. |
145+
| `Type: New Feature` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20Type%20New%20Feature) | Applied to issues and pull requests requesting or implementing new features. | |
146+
| `Type: Optimization` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20Type%20Optimization) | Applied to issues and pull requests regarding optimizing existing code. | |
147+
| `Type: Security` | [search](https://github.com/empty2k12/influxdb-rust/labels/status%3a%20Type%20Security) | Applied to issues and pull requests regarding the security of the library. | |
148+
149+
#### Size of Change Labels
150+
151+
| Issue label | List issues | Description |
152+
| ------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
153+
| `Type of Change: Master` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Type%20of%20Change%3A%20Master) | Applied to issues and pull requests which are major changes. |
154+
| `Type of Change: Medium` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Type%20of%20Change%3A%20Medium) | Applied to issues and pull requests which are medium changes. |
155+
| `Type of Change: Minor` | [search](https://github.com/Empty2k12/influxdb-rust/labels/Type%20of%20Change%3A%20Minor) | Applied to issues and pull requests which are small changes. |
156+
157+
#### Misc Labels
158+
159+
| Issue label | List issues | Description |
160+
| ---------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
161+
| good first issue | [search](https://github.com/Empty2k12/influxdb-rust/labels/good%20first%20issue) | Indicates this issue is suited for new contributors |
162+
| Hacktoberfest | [search](https://github.com/Empty2k12/influxdb-rust/labels/Hacktoberfest) | Issues which are suited for someone taking part in Hacktoberfest. |
163+
164+
This document has been adopted from [Atom contributing guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)

Diff for: ‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
</p>
2929

3030
This library is a work in progress. Although we've been using it in production at [OpenVelo](https://openvelo.org/),
31-
we're prioritized features that fit our use cases. This means a feature you might need is not implemented
31+
we've prioritized features that fit our use cases. This means a feature you might need is not implemented
3232
yet or could be handled better.
3333

34-
Pull requests are always welcome.
34+
Pull requests are always welcome. See [Contributing](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md).
3535

3636
## Currently Supported Features
3737

0 commit comments

Comments
 (0)