Skip to content

Commit ff086af

Browse files
authored
docs: add runtime documentation (#3)
1 parent 574fb72 commit ff086af

File tree

15 files changed

+721
-108
lines changed

15 files changed

+721
-108
lines changed

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
golang 1.21
1+
golang 1.21.5

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contribute
2+
3+
> A guide for contributing to `new-dockerfile`
4+
5+
## Getting Started
6+
7+
1. [Install asdf](https://asdf-vm.com/guide/getting-started.html) - A CLI tool that can manage multiple
8+
language runtime versions on a per-project basis
9+
10+
3. Clone the repo and open in VSCode
11+
12+
```sh
13+
git clone https://github.com/flexstack/new-dockerfile
14+
code new-dockerfile
15+
```
16+
17+
4. Install the project's dependencies
18+
19+
```sh
20+
asdf install
21+
go mod download
22+
```
23+
24+
## Development
25+
26+
Run the CLI in development mode:
27+
28+
```sh
29+
go run ./cmd/new-dockerfile --help
30+
```
31+
32+
Vet code
33+
```sh
34+
go vet ./...
35+
```
36+
37+
Run tests
38+
```sh
39+
go test -v ./...
40+
```
41+
42+
## Open an issue
43+
44+
If you find a bug or want to request a new feature, please open an issue.
45+
46+
## Submit a pull request
47+
48+
Before submitting a feature pull request, it is important to open an issue to discuss what you plan to work on to ensure success in releasing your changes.
49+
For small bug fixes or improvements, go ahead and submit a pull request without an issue.
50+
51+
1. Fork the repo
52+
2. Create a new branch (`git checkout -b feature/my-feature`)
53+
3. Make your changes
54+
4. Commit your changes (`git commit -am 'Add my feature'`)
55+
5. Push to the branch (`git push origin feature/my-feature`)
56+
6. Create a new Pull Request
57+
58+
## License
59+
60+
MIT

0 commit comments

Comments
 (0)