Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@ How do you like to solve the issue and why?
- [ ] I have read the [contribution guidelines](https://external-secrets.io/latest/contributing/process/#submitting-a-pull-request)
- [ ] All commits are signed with `git commit --signoff`
- [ ] My changes have reasonable test coverage
- [ ] All tests pass with `make test`
- [ ] I ensured my PR is ready for review with `make reviewable`
- [ ] All tests pass with `make test-ci`
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ hack/rootCA.pem

# Bitwarden state file
.bitwarden-state

# delve debug files
__debug_*
36 changes: 36 additions & 0 deletions docs/contributing/devguide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Local Setup

How to run this repo locally (after cloning):

* First [install a recent version of go](https://go.dev/doc/install) (see [go.mod](../../go.mod) for the minimum version).

* Then run the following:

````bash
cd bitwarden-sdk-server/

# install go dependencies
go mod tidy

# launch server
go run main.go serve --insecure --hostname :9998 --debug

# alternatively you can launch the server with the delve debugger:
go install github.com/go-delve/delve/cmd/dlv@v1.26.1

dlv debug main.go -- serve --insecure --hostname :9998 --debug
# optionally set a breakpoint at a given function
break funcs listSecretsHandler
# and start code execution
continue
````

## Unit Tests

````bash
# run test suite
make test-ci

# if you're on mac run
CGO_LDFLAGS="-framework CoreFoundation" CGO_ENABLED=1 go test ./... -coverprofile cover.out
````
37 changes: 37 additions & 0 deletions docs/contributing/process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Project Management
The Code, our TODOs and Documentation is maintained on
[GitHub](https://github.com/external-secrets/bitwarden-sdk-server). All Issues
Comment thread
dangbert marked this conversation as resolved.
should be opened in that repository.

## Issues

Features, bugs and any issues regarding the documentation should be filed as
[GitHub Issue](https://github.com/external-secrets/bitwarden-sdk-server/issues) in
our repository. We use labels like `kind/feature`, `kind/bug`, `area/aws` to
organize the issues. Issues labeled `good first issue` and `help wanted` are
especially good for a first contribution. If you want to pick up an issue just
leave a comment.

## Submitting a Pull Request

This project uses the well-known pull request process from GitHub. To submit a
pull request, fork the repository and push any changes to a branch on the copy,
from there a pull request can be made in the main repo. Merging a pull request
requires the following steps to be completed before the pull request will
be merged:

* ideally, there is an issue that documents the problem or feature in depth.
* code must have a reasonable amount of test coverage
* tests must pass
* PR needs be reviewed and approved

Once these steps are completed the PR will be merged by a code owner.
We're using the pull request `assignee` feature to track who is responsible
for the lifecycle of the PR: review, merging, ping on inactivity, close.
We close pull requests or issues if there is no response from the author for
a period of time. Feel free to reopen if you want to get back on it.

_Note:_
Pull requests that are labelled with _size/l_ and above _MUST_ have at least **TWO**
approvers for it to be merged. Please respect this policy to ensure the quality
of code in this project.