Skip to content

Commit 6cc845b

Browse files
stringbeanstringbean
authored
Add issue templates (#18)
1 parent ddf240f commit 6cc845b

File tree

7 files changed

+299
-0
lines changed

7 files changed

+299
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to make participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, sex characteristics, gender identity and expression,
10+
level of experience, education, socio-economic status, nationality, personal
11+
appearance, race, 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+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies within all project spaces, and it also applies when
50+
an individual is representing the project or its community in public spaces.
51+
Examples of representing a project or community include using an official
52+
project e-mail address, posting via an official social media account, or acting
53+
as an appointed representative at an online or offline event. Representation of
54+
a project may be further defined and clarified by project maintainers.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the project team on
60+
[Gitter](https://gitter.im/stringbean/sbt-dependency-lock). All
61+
complaints will be reviewed and investigated and will result in a response that
62+
is deemed necessary and appropriate to the circumstances. The project team is
63+
obligated to maintain confidentiality with regard to the reporter of an incident.
64+
Further details of specific enforcement policies may be posted separately.
65+
66+
Project maintainers who do not follow or enforce the Code of Conduct in good
67+
faith may face temporary or permanent repercussions as determined by other
68+
members of the project's leadership.
69+
70+
## Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
73+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
74+
75+
[homepage]: https://www.contributor-covenant.org
76+
77+
For answers to common questions about this code of conduct, see
78+
https://www.contributor-covenant.org/faq

‎.github/CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
Welcome and thanks for taking the time to contribute to this project!
4+
5+
6+
## Building & Preparing PRs
7+
8+
Before submitting a PR please ensure that you have run the following sbt tasks:
9+
10+
* `test`
11+
* `scripted`
12+
* `scalafmt`
13+
* `headerCheck`
14+
15+
This should ensure that everything works and meets the styleguide.
16+
17+
PRs will get automatically built by [Travis CI](https://travis-ci.com/stringbean/sbt-dependency-lock) - please make sure the build passes before marking as ready.
18+
19+
## Documentation
20+
21+
The documentation site is built using [Paradox](https://github.com/lightbend/paradox) and lives in the `src/main/paradox` directory. You can preview the site by running:
22+
23+
```sh
24+
sbt previewSite
25+
```

‎.github/ISSUE_TEMPLATE/--bug-report.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: "\U0001F41BBug report"
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, triage required
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Thanks for reporting a bug in sbt-dependency-lock.
12+
13+
Please try to fill in as much of the information as possible so we can identify the root cause. Providing access to a repository that demonstrates the issue will greatly speed up diagnosing the issue.
14+
-->
15+
16+
## Project Information
17+
18+
* **sbt version:** 1.x.y
19+
* **Coursier?** _(1.3+ uses Coursier by default)_
20+
* **Scala versions:** 2.x
21+
* **Java version:** 11.x
22+
* **Operating system:** Linux/macOS/Windows
23+
* **Link to project repo:** _(if the repo if private can you link to a demo of the issue)_
24+
25+
### Steps to Reproduce
26+
27+
1. Change x, y, z
28+
2. Run `dependencyLockCheck`
29+
30+
## Behaviour
31+
32+
### Expected
33+
_What did you expect to happen?_
34+
35+
<details>
36+
<summary>Dependency Check Output</summary>
37+
38+
```text
39+
[output of dependencyLockCheck]
40+
```
41+
</details>
42+
43+
### Actual
44+
_What actually happened?_
45+
46+
<details>
47+
<summary>Dependency Check Output</summary>
48+
49+
```text
50+
[output of dependencyLockCheck]
51+
```
52+
</details>
53+
54+
<details>
55+
<summary>Java Stack Trace</summary>
56+
57+
```text
58+
[Any outputted stack trace]
59+
```
60+
</details>

‎.github/ISSUE_TEMPLATE/--feature-request.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: "\U0001F680Feature request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Thank you for suggesting improvements to sbt-dependency-lock.
12+
13+
Please include as much detail as possible in this feature request.
14+
-->
15+
16+
## What are you suggesting?
17+
_I think sbt-dependency-lock should..._
18+
19+
## How will this benefit other users?
20+
_This will make it easier to..._
21+
22+
## Is there a workaround that can do this now?
23+
_Have you found a different way of doing this without this enhancement?_
24+
25+
## Will this require a lock file change?
26+
_Lock file changes require extra work and force users to migrate their lock files._
27+
28+
## Other details
29+
_Links to repos to that need this, examples of other projects that do this etc_

‎.github/PULL_REQUEST_TEMPLATE/bug-fix.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: "Bug fix"
3+
about: For all PRs that fix bugs
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
This PR fixes #.
10+
11+
## Behaviour
12+
13+
### Before
14+
15+
<details>
16+
<summary>Dependency Check Output</summary>
17+
18+
```text
19+
[output of dependencyLockCheck]
20+
```
21+
</details>
22+
23+
### After
24+
25+
<details>
26+
<summary>Dependency Check Output</summary>
27+
28+
```text
29+
[output of dependencyLockCheck]
30+
```
31+
</details>
32+
33+
## Does this PR require a lock file change?
34+
35+
Yes/No
36+
37+
_If yes then this will need to form part of a new major release_
38+
39+
## Checklist
40+
41+
- [ ] I have read the CONTRIBUTING guidelines
42+
- [ ] User documentation has been updated
43+
- [ ] Unit and/or sbt tests have been added for the changes
44+
- [ ] I have run the following sbt commands:
45+
- [ ] `test`
46+
- [ ] `scripted`
47+
- [ ] `scalafmt` & `test:scalafmt`
48+
- [ ] `headerCheck` & `test:headerCheck`
49+
50+
## Description for the release notes
51+
52+
_If there is anything in particular you want to highlight in the release notes
53+
then add it here._

‎.github/PULL_REQUEST_TEMPLATE/enhancement.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: "Enhancement"
3+
about: For all PRs that improve or add functionality
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
This PR implements #.
10+
11+
## Behaviour
12+
13+
### Before
14+
15+
<details>
16+
<summary>Dependency Check Output</summary>
17+
18+
```text
19+
[output of dependencyLockCheck]
20+
```
21+
</details>
22+
23+
### After
24+
25+
<details>
26+
<summary>Dependency Check Output</summary>
27+
28+
```text
29+
[output of dependencyLockCheck]
30+
```
31+
</details>
32+
33+
## Does this PR require a lock file change?
34+
35+
Yes/No
36+
37+
_If yes then this will need to form part of a new major release_
38+
39+
## Checklist
40+
41+
- [ ] I have read the CONTRIBUTING guidelines
42+
- [ ] User documentation has been updated
43+
- [ ] Unit and/or sbt tests have been added for the changes
44+
- [ ] I have run the following sbt commands:
45+
- [ ] `test`
46+
- [ ] `scripted`
47+
- [ ] `scalafmt` & `test:scalafmt`
48+
- [ ] `headerCheck` & `test:headerCheck`
49+
50+
## Description for the release notes
51+
52+
_If there is anything in particular you want to highlight in the release notes
53+
then add it here._

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Codacy grade](https://img.shields.io/codacy/grade/d45ca406c90c45c88a3a317563bc3302?label=codacy)](https://codacy.com/app/stringbean/sbt-dependency-lock)
44
[![Known Vulnerabilities](https://snyk.io/test/github/stringbean/sbt-dependency-lock/badge.svg?targetFile=build.sbt)](https://snyk.io/test/github/stringbean/sbt-dependency-lock?targetFile=build.sbt)
55
![Bintray](https://img.shields.io/bintray/v/stringbean/sbt-plugins/sbt-dependency-lock?label=sbt%201.x)
6+
[![Join the chat at https://gitter.im/sbt-dependency-lock/community](https://badges.gitter.im/sbt-dependency-lock/community.svg)](https://gitter.im/sbt-dependency-lock/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
67

78
An sbt plugin to create a dependency lockfile similar to `package-lock.json` for npm or `Gemfile.lock` for RubyGems.
89

0 commit comments

Comments
 (0)