Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add issue and PR templates #162

Merged
merged 4 commits into from
Mar 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
**Note: for support questions, please use [gitter] or [users forums]**. This
repository's issues are reserved for feature requests and bug reports.

[gitter]: https://gitter.im/uuid-rs/Lobby
[users forums]: https://users.rust-lang.org

**I'm submitting a ...**
- [ ] bug report
- [ ] feature request
- [ ] support request => Please do not submit support request here, see note
at the top of this template.


# Description
<!-- Provide a summary of your issue in the Title above -->

<!--
The following section is only needed for bug reports, delete otherwise.
-->
# Bug Report

## Current Behaviour
<!-- What is the current behavior? -->

## Expected Behaviour
<!-- What is the expected behaviour? -->

## Steps to Reproduce
<!-- How can we reproduce this bug? -->
1. ...
2. ...
3. ...

## Example
<!--
A code snippet or a play.rust-lang.org link will do.
Not obligatory, but will provide a context for the bug.
-->

## Environment
<!-- Please tell us about your environment -->
- Version: <!-- uuid version -->
- Target: <!-- Your target triple -->
- Features: <!-- uuid features enabled -->

## Meta
<!--
Information like detailed explanation, stacktraces, suggested fixes, etc
-->

<!--
The following section is only for feature requests, delete otherwise
-->
# Feature Request
<!-- What is the motivation/ use-case(s) for changing the behavior? -->

# Other
<!-- Other information like relevant issues, external links, etc -->
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Description
<!-- Provide a summary of your issue in the Title above -->

# Current Behaviour
<!-- What is the current behavior? -->

# Expected Behaviour
<!-- What is the expected behaviour? -->

# Steps to Reproduce
<!-- How can we reproduce this bug? -->
1. ...
2. ...
3. ...

# Example
<!--
A code snippet or a play.rust-lang.org link will do.
Not obligatory, but will provide a context for the bug.
-->

# Environment
<!-- Please tell us about your environment -->
- Version: <!-- uuid version -->
- Target: <!-- Your target triple -->
- Features: <!-- uuid features enabled -->

# Meta
<!-- Information like detailed explanation, stacktraces, suggested fixes, etc -->

# Other
<!-- Other information like relevant issues, external links, etc -->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/feature
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Description
<!-- Provide a summary of your issue in the Title above -->

# Feature Request
<!-- What is the motivation/ use-case(s) for changing the behavior? -->

# Other
<!-- Other information like relevant issues, external links, etc -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/tracker
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--
Title should be in the format:

`Tracker: version release`

Replace version with the target release.
-->

<!-- Replace version with the version for this tracker is being opened -->
Items left to do for __*version*__ release:

* [ ] Update version numbers
* [ ] Push to crates.io
* [ ] Write release notes on:
* [ ] Github Releases
* [ ] users.rust-lang.org
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
As we are working towards a stable version of uuid, we require that you
open an issue, before submitting a pull request. If the pull request is
imcomplete, prepend the Title with WIP:
-->

**I'm submitting a ...**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: This might read a bit better if we change the checkboxes to be singular. So instead of bug fixes we'd say bug fix. What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- [ ] bug fix
- [ ] feature enhancement
- [ ] deprecation or removal
- [ ] refactor

# Description
<!-- Provide a summary of your changes in the Title above -->

# Motivation
<!-- Why is this change required -->

# Tests
<!-- How are these changes tested? -->

# Related Issue(s)
<!--
As noted above, we require an issue for every PR. Please link to the issue
here
-->
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--
Title should be in the format:

`version release update`

Replace version with the target release.
-->

<!-- Replace version with the version for this tracker is being opened -->
Items left to do for __*version*__ release:

* [ ] Update version numbers
* [ ] lib.rs
* [ ] Cargo.toml

Reference: #<!-- Tracker issue -->
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
uuid
====

[![Build Status](https://travis-ci.org/uuid-rs/uuid.svg?branch=master)](https://travis-ci.org/uuid-rs/uuid) [![Appveyor Status](https://ci.appveyor.com/api/projects/status/github/uuid-rs/uuid?branch=master&svg=true)](https://ci.appveyor.com/project/KodrAus/uuid) [![Latest Version](https://img.shields.io/crates/v/uuid.svg)](https://crates.io/crates/uuid) [![Join the chat at https://gitter.im/uuid-rs/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/uuid-rs/Lobby?utm_source=badge&utm_medium=badge&utm_content=badge)
[![Build Status](https://travis-ci.org/uuid-rs/uuid.svg?branch=master)](https://travis-ci.org/uuid-rs/uuid)
[![Appveyor Status](https://ci.appveyor.com/api/projects/status/github/uuid-rs/uuid?branch=master&svg=true)](https://ci.appveyor.com/project/KodrAus/uuid)
[![Latest Version](https://img.shields.io/crates/v/uuid.svg)](https://crates.io/crates/uuid)
[![Join the chat at https://gitter.im/uuid-rs/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/uuid-rs/Lobby?utm_source=badge&utm_medium=badge&utm_content=badge)

A Rust library to generate and parse UUIDs.

Expand Down