-
Notifications
You must be signed in to change notification settings - Fork 16
docs: add missing devguide.md + process.md #79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,3 +27,6 @@ hack/rootCA.pem | |
|
|
||
| # Bitwarden state file | ||
| .bitwarden-state | ||
|
|
||
| # delve debug files | ||
| __debug_* | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ```` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.