Skip to content

Commit

Permalink
Perform some basic housekeeping
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAure committed Nov 6, 2023
1 parent 8b5b1d1 commit 4daee98
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 24 deletions.
18 changes: 0 additions & 18 deletions .dependabot/config.yml

This file was deleted.

6 changes: 0 additions & 6 deletions .github/CODEOWNERS

This file was deleted.

11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily

- package-ecosystem: gradle
directory: /
schedule:
interval: daily
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to MicroProfile Starter Extension for VS Code

We welcome contributions, and request you follow these guidelines.

- [Raising issues](#raising-issues)
- [Legal](#legal)
- [Coding Standards](#coding-standards)
- [Project Setup](#project-setup)

### Raising issues

Please raise any bug reports on the [issue tracker](https://github.com/MicroShed/microshed-testing/issues). Be sure to search the list to see if your issue has already been raised.

A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.

### Legal

In order to make contribution as easy as possible, we follow the same approach as the [Developer's Certificate of Origin 1.1 (DCO)](https://developercertificate.org/) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin) uses to manage code contributions.

We simply ask that when submitting a pull request for review, the developer
must include a sign-off statement in the commit message.

Here is an example Signed-off-by line, which indicates that the
submitter accepts the DCO:

```text
Signed-off-by: John Doe <[email protected]>
```

You can include this automatically when you commit a change to your
local git repository using the following command:

```bash
git commit -s
```

### Coding Standards

This project contains a CI build that should run successfully.
Upon opening a Pull Request or Merging a commit this build will run.
If your Pull Request results in the failure of this build it will not be reviewed or merged until the failure is fixed.

### Project Setup

##### Requirements

- JDK 8 or higher
- Docker (daemon or desktop)
<!-- TODO support podman/colima for builds -->

##### Building project

Use the gradle wrapper to build this project:

```sh
./gradlew build
```

0 comments on commit 4daee98

Please sign in to comment.