Skip to content

Commit d6fe019

Browse files
committed
docs: add missing devguide.md + process.md
Signed-off-by: Daniel Engbert <end1@umbc.edu>
1 parent 37759d4 commit d6fe019

3 files changed

Lines changed: 66 additions & 0 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,6 @@ hack/rootCA.pem
2727

2828
# Bitwarden state file
2929
.bitwarden-state
30+
31+
# delve debug files
32+
__debug_*

docs/contributing/devguide.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Local Setup
2+
3+
How to run this repo locally (after cloning):
4+
5+
* First [install a recent version of go](https://go.dev/doc/install) (see [go.mod](../../go.mod) for the minimum version).
6+
7+
* Then run the following:
8+
9+
````bash
10+
cd bitwarden-sdk-server/
11+
12+
# install go dependencies
13+
go mod tidy
14+
15+
# launch server
16+
go run main.go server --insecure --hostname :9998 --debug
17+
18+
# alternatively you can launch the server with the delve debugger:
19+
go install github.com/go-delve/delve/cmd/dlv@v1.26.1
20+
21+
dlv debug main.go -- serve --insecure --hostname :9998 --debug
22+
# optionally set a breakpoint at a given function
23+
break funcs listSecretsHandler
24+
# and start code execution
25+
continue
26+
````

docs/contributing/process.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Project Management
2+
The Code, our TODOs and Documentation is maintained on
3+
[GitHub](https://github.com/external-secrets/bitwarden-sdk-server). All Issues
4+
should be opened in that repository.
5+
6+
## Issues
7+
8+
Features, bugs and any issues regarding the documentation should be filed as
9+
[GitHub Issue](https://github.com/external-secrets/bitwarden-sdk-server/issues) in
10+
our repository. We use labels like `kind/feature`, `kind/bug`, `area/aws` to
11+
organize the issues. Issues labeled `good first issue` and `help wanted` are
12+
especially good for a first contribution. If you want to pick up an issue just
13+
leave a comment.
14+
15+
## Submitting a Pull Request
16+
17+
This project uses the well-known pull request process from GitHub. To submit a
18+
pull request, fork the repository and push any changes to a branch on the copy,
19+
from there a pull request can be made in the main repo. Merging a pull request
20+
requires the following steps to be completed before the pull request will
21+
be merged:
22+
23+
* ideally, there is an issue that documents the problem or feature in depth.
24+
* code must have a reasonable amount of test coverage
25+
* tests must pass
26+
* PR needs be reviewed and approved
27+
28+
Once these steps are completed the PR will be merged by a code owner.
29+
We're using the pull request `assignee` feature to track who is responsible
30+
for the lifecycle of the PR: review, merging, ping on inactivity, close.
31+
We close pull requests or issues if there is no response from the author for
32+
a period of time. Feel free to reopen if you want to get back on it.
33+
34+
_Note:_
35+
Pull requests that are labelled with _size/l_ and above _MUST_ have at least **TWO**
36+
approvers for it to be merged. Please respect this policy to ensure the quality
37+
of code in this project.

0 commit comments

Comments
 (0)