Thank you for contributing. It's much apprechiated!
The following is a set of guidelines for contributing to influxdb-rust, which is hosted at influxdb-rs/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.
This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
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.
Bugs are tracked as GitHub issues. Please fill out the bug report template when filing a bug.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- 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.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of influxdb-rust) or was this always a problem?
- 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.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
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.
When you are creating an enhancement suggestion, please include as many details as possible. Fill in the enhancement suggestion template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most influxdb-rust users.
- Specify the name and version of the OS you're using.
Unsure where to begin contributing to influxdb-rust? You can start by looking through these good first issue and Type of Change: Minor issues:
- good first issue issues - issues which are suited for new developers. usually just some lines of code or just a test.
- Type of Change: Minor issues - issues which only change a small amount of code in the library.
- Hacktoberfest issues - issues which are suited for someone taking part in Hacktoberfest.
influxdb-rust can be developed locally.
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.
The process described here has several goals:
- Maintain influxdb-rust's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible influxdb-rust
- Enable a sustainable system for influxdb-rust's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
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.
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.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
Please format your code using cargo fmt --all and make sure cargo clippy produces no warnings.
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in.
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.
Please open an issue if you have suggestions for new labels.
| Issue label | List issues | Description |
|---|---|---|
Status: Merge when CI passes |
search | Applied when the pull request has been reviewed and is ready for merge once the CI pipeline passes. |
Status: Awaiting Response |
search | Applied to issues which have a response from the issue owner pending. |
Status: Pending Discussion |
search | Applied to pull requests where a pull request review has been submitted and the pull request author has not responded to feedback yet. |
Status: Pending Updates |
search | Applied to pull requests where updates to the changeset is pending. |
Status: Work in Progress |
search | Applied to pull requests that are work in progress. |
| Issue label | List issues | Description |
|---|---|---|
Type: Bug |
search | Applied to issues reporting bugs. |
Type: Chore |
search | Applied to issues and pull requests regarding miscellaneous tasks around the reposity. |
Type: Enhancement |
search | Applied to issues and pull requests where an existing feature is improved. |
Type: Governance |
search | Applied to issues pull requests regarding repository governance. |
Type: New Feature |
search | Applied to issues and pull requests requesting or implementing new features. |
Type: Optimization |
search | Applied to issues and pull requests regarding optimizing existing code. |
Type: Security |
search | Applied to issues and pull requests regarding the security of the library. |
| Issue label | List issues | Description |
|---|---|---|
Type of Change: Master |
search | Applied to issues and pull requests which are major changes. |
Type of Change: Medium |
search | Applied to issues and pull requests which are medium changes. |
Type of Change: Minor |
search | Applied to issues and pull requests which are small changes. |
| Issue label | List issues | Description |
|---|---|---|
| good first issue | search | Indicates this issue is suited for new contributors |
| Hacktoberfest | search | Issues which are suited for someone taking part in Hacktoberfest. |
This document has been adopted from Atom contributing guidelines