Skip to content
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
78 changes: 78 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team on
[Gitter](https://gitter.im/stringbean/sbt-dependency-lock). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

Welcome and thanks for taking the time to contribute to this project!


## Building & Preparing PRs

Before submitting a PR please ensure that you have run the following sbt tasks:

* `test`
* `scripted`
* `scalafmt`
* `headerCheck`

This should ensure that everything works and meets the styleguide.

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.

## Documentation

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:

```sh
sbt previewSite
```
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/--bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: "\U0001F41BBug report"
about: Create a report to help us improve
title: ''
labels: bug, triage required
assignees: ''

---

<!--
Thanks for reporting a bug in sbt-dependency-lock.

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.
-->

## Project Information

* **sbt version:** 1.x.y
* **Coursier?** _(1.3+ uses Coursier by default)_
* **Scala versions:** 2.x
* **Java version:** 11.x
* **Operating system:** Linux/macOS/Windows
* **Link to project repo:** _(if the repo if private can you link to a demo of the issue)_

### Steps to Reproduce

1. Change x, y, z
2. Run `dependencyLockCheck`

## Behaviour

### Expected
_What did you expect to happen?_

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

### Actual
_What actually happened?_

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

<details>
<summary>Java Stack Trace</summary>

```text
[Any outputted stack trace]
```
</details>
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/--feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "\U0001F680Feature request"
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

<!--
Thank you for suggesting improvements to sbt-dependency-lock.

Please include as much detail as possible in this feature request.
-->

## What are you suggesting?
_I think sbt-dependency-lock should..._

## How will this benefit other users?
_This will make it easier to..._

## Is there a workaround that can do this now?
_Have you found a different way of doing this without this enhancement?_

## Will this require a lock file change?
_Lock file changes require extra work and force users to migrate their lock files._

## Other details
_Links to repos to that need this, examples of other projects that do this etc_
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: "Bug fix"
about: For all PRs that fix bugs
title: ''
labels: bug
assignees: ''
---

This PR fixes #.

## Behaviour

### Before

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

### After

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

## Does this PR require a lock file change?

Yes/No

_If yes then this will need to form part of a new major release_

## Checklist

- [ ] I have read the CONTRIBUTING guidelines
- [ ] User documentation has been updated
- [ ] Unit and/or sbt tests have been added for the changes
- [ ] I have run the following sbt commands:
- [ ] `test`
- [ ] `scripted`
- [ ] `scalafmt` & `test:scalafmt`
- [ ] `headerCheck` & `test:headerCheck`

## Description for the release notes

_If there is anything in particular you want to highlight in the release notes
then add it here._
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: "Enhancement"
about: For all PRs that improve or add functionality
title: ''
labels: enhancement
assignees: ''
---

This PR implements #.

## Behaviour

### Before

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

### After

<details>
<summary>Dependency Check Output</summary>

```text
[output of dependencyLockCheck]
```
</details>

## Does this PR require a lock file change?

Yes/No

_If yes then this will need to form part of a new major release_

## Checklist

- [ ] I have read the CONTRIBUTING guidelines
- [ ] User documentation has been updated
- [ ] Unit and/or sbt tests have been added for the changes
- [ ] I have run the following sbt commands:
- [ ] `test`
- [ ] `scripted`
- [ ] `scalafmt` & `test:scalafmt`
- [ ] `headerCheck` & `test:headerCheck`

## Description for the release notes

_If there is anything in particular you want to highlight in the release notes
then add it here._
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Codacy grade](https://img.shields.io/codacy/grade/d45ca406c90c45c88a3a317563bc3302?label=codacy)](https://codacy.com/app/stringbean/sbt-dependency-lock)
[![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)
![Bintray](https://img.shields.io/bintray/v/stringbean/sbt-plugins/sbt-dependency-lock?label=sbt%201.x)
[![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)

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

Expand Down