-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## What? Adds community health files (PR and issue templates, contributing guidelines). ## Why? These files simplify contributions to the project.
- Loading branch information
Showing
7 changed files
with
100 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Bug report | ||
about: Use this template for reporting issues | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
## Bug report | ||
|
||
<!-- Provide a concise description of the bug. --> | ||
|
||
### Steps to reproduce | ||
|
||
<!-- Describe steps to reproduce the bug. --> | ||
|
||
### Expected behavior | ||
|
||
<!-- Describe what you expected to happen from the library. --> | ||
|
||
### Environment | ||
|
||
<!-- Include relevant environment information. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Feature request | ||
about: Use this template to request features | ||
title: '' | ||
labels: feat | ||
assignees: '' | ||
--- | ||
|
||
## Feature request | ||
|
||
<!-- Provide a concise description of the feature you'd like to see implemented. --> | ||
|
||
### Why? | ||
|
||
<!-- Explain why this feature is important, guiding use case(s) etc. --> | ||
|
||
### Alternatives | ||
|
||
<!-- Briefly describe potential alternatives you've considered. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## What? | ||
|
||
<!-- Briefly describe changes in the PR. If there are several things, organize them as a list. --> | ||
<!-- Example: This PR adds a PR template to the repo. --> | ||
<!-- If applicable, attach related issue(s) --> | ||
|
||
## Why? | ||
|
||
<!-- What is the motivation behind the PR? --> | ||
<!-- If applicable (e.g., for PRs implementing a large new feature), describe potential alternatives | ||
and their pros / cons. --> | ||
<!-- Example: PR templates simplify contributions to the project and structure it commit log. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing to `term-transcript` | ||
|
||
This project welcomes contribution from everyone, which can take form of suggestions / feature requests, bug reports, or pull requests. | ||
This document provides guidance how best to contribute. | ||
|
||
## Bug reports and feature requests | ||
|
||
For bugs or when asking for help, please use the bug issue template and include enough details so that your observations | ||
can be reproduced. | ||
|
||
For feature requests, please use the feature request issue template and describe the intended use case(s) and motivation | ||
to go for them. If possible, include your ideas how to implement the feature, potential alternatives and disadvantages. | ||
|
||
## Pull requests | ||
|
||
Please use the pull request template when submitting a PR. List the major goal(s) achieved by the PR | ||
and describe the motivation behind it. If applicable, like to the related issue(s). | ||
|
||
Optimally, you should check locally that the CI checks pass before submitting the PR. Checks included in the CI | ||
include: | ||
|
||
- Formatting using `cargo fmt --all` | ||
- Linting using `cargo clippy` | ||
- Linting the dependency graph using [`cargo deny`](https://crates.io/crates/cargo-deny) | ||
- Running the test suite using `cargo test` | ||
|
||
A complete list of checks can be viewed in [the CI workflow file](.github/workflows/ci.yml). The checks are run | ||
on the latest stable Rust version. | ||
|
||
### MSRV checks | ||
|
||
A part of the CI assertions is the minimum supported Rust version (MSRV). If this check fails, consult the error messages. Depending on | ||
the error (e.g., whether it is caused by a newer language feature used in the PR code, or in a dependency), | ||
you might want to rework the PR, get rid of the offending dependency, or bump the MSRV; don't hesitate to consult the maintainers. | ||
|
||
## Code of Conduct | ||
|
||
Be polite and respectful. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters