Skip to content

Commit

Permalink
chore: documentations (#2)
Browse files Browse the repository at this point in the history
* chore: update contributing.md
Update properly for Go project.

* chore: run pre-commit on codeowners

* chore: add changelog entry
  • Loading branch information
karmingc committed May 26, 2023
1 parent b081a9d commit 3af2f71
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 50 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @karmingc
* @karmingc
51 changes: 2 additions & 49 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,55 +11,8 @@ Thanks for your interest. This document includes guides and steps how to setup t

### Installing the dependencies

1. Have python installed. We suggest using [pyenv](https://github.com/pyenv/pyenv) to manage python versions.

2. Create virtualenv.

```sh
$ python -m venv venv
```

3. Activate virtualenv.

```sh
$ source venv/bin/activate
```

4. Install [pip-tools](https://github.com/jazzband/pip-tools).

```sh
$ python -m pip install pip-tools
```

5. Run pip-sync to download dependencies.

```
$ pip-sync
```

### Adding dependencies

1. Add the dependency in requirements.in.

```python
--- a/requirements.in
+++ b/requirements.in
@@ -1 +1,2 @@
pre-commit
+pytest
```

2. Run `pip-compile`, which adds it to your `requirements.txt`.

```sh
$ pip-compile
```

3. Run `pip-sync` to install the missing dependencies.

```sh
$ pip-sync
```
1. Install Go. Visit [Download and install](https://go.dev/doc/install) for more information.
2. Running `go run main.go` will automatically download the dependencies and execute the program.

### Pre-commit

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
changes:
- type: patch
scope: chore/docs
description: Fix documentation in contributing.md

0 comments on commit 3af2f71

Please sign in to comment.