Skip to content

Commit 2470d9e

Browse files
authored
Installation and contributing docs (#35)
1 parent 523369a commit 2470d9e

File tree

3 files changed

+89
-0
lines changed

3 files changed

+89
-0
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Thanks for considering contributing to this project!
4+
5+
## Opening issues
6+
7+
If you find a bug, please feel free to [open an issue](https://github.com/elastic/elastic-agent-changelog-tool/issues).
8+
9+
## Fixing bugs
10+
11+
We love pull requests. Here’s a quick guide:
12+
13+
1. [Fork this repository](https://github.com/elastic/elastic-agent-changelog-tool/fork) and then clone it locally:
14+
15+
```bash
16+
$ git clone https://github.com/elastic/elastic-agent-changelog-tool
17+
$ cd elastic-agent-changelog-tool
18+
$ make build # ensure building the binary works
19+
$ make test # ensure tests are green
20+
```
21+
22+
2. Create a topic branch for your changes:
23+
24+
```bash
25+
git checkout -b fix-for-that-thing
26+
```
27+
3. Commit a failing test for the bug:
28+
29+
```bash
30+
git commit -am "Adds a failing test to demonstrate that thing"
31+
```
32+
33+
4. Commit a fix that makes the test pass:
34+
35+
```bash
36+
git commit -am "Adds a fix for that thing!"
37+
```
38+
39+
5. Run the tests:
40+
41+
```bash
42+
make test
43+
```
44+
45+
6. If everything looks good, push to your fork:
46+
47+
```bash
48+
git push origin fix-for-that-thing
49+
```
50+
51+
7. [Submit a pull request.](https://help.github.com/articles/creating-a-pull-request)
52+
53+
## Adding new features
54+
55+
[Open an issue](https://github.com/elastic/elastic-agent-changelog-tool/issues) and let’s design it together.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ Tooling to manage the changelog for beats, Elastic Agent and Fleet Server
55

66
`git` CLI should be installed and available.
77
[`go-licenser`](https://github.com/elastic/go-licenser) CLI should be installed and available.
8+
9+
## Contributing
10+
11+
Thinking of contributing? Thank you! Look at [`./CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines.

docs/install.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Installation
2+
3+
## Install from release binary
4+
5+
Download latest release from the [Releases](https://github.com/elastic/elastic-agent-changelog-tool/releases/latest) page.
6+
7+
On macOS, use `xattr -r -d com.apple.quarantine elastic-agent-changelog-tool` after downloading to allow the binary to run.
8+
9+
## Install with go install
10+
11+
If you have a `go` development environment setup, you can use `go install`:
12+
13+
```
14+
$ go install github.com/elastic/elastic-agent-changelog-tool@latest
15+
```
16+
17+
_Please make sure that you've correctly [setup environment variables](https://golang.org/doc/gopath_code.html#GOPATH) -
18+
`$GOPATH` and `$PATH`, and `elastic-agent-changelog-tool` should be accessible from your `$PATH`._
19+
20+
## Install from source code
21+
22+
If you have a `go` development environment, you can clone this repo and build the source files with:
23+
24+
```
25+
$ git clone https://github.com/elastic/elastic-agent-changelog-tool.git
26+
$ cd elastic-agent-changelog-tool
27+
$ make build
28+
```
29+
30+
`elastic-agent-changelog-tool` binary will be created in the root folder.

0 commit comments

Comments
 (0)