Skip to content

Commit 4c51ade

Browse files
authored
chore: Minor improvements to CONTRIBUTING.md (#3447)
1 parent d586dc4 commit 4c51ade

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,16 @@ To make the contribution process as seamless as possible, we ask for the followi
5555
#### Environment
5656

5757
- Fork the repository.
58-
- Clone your forked repository locally.
59-
- We use Go Modules to manage dependencies, so you can develop outside your `$GOPATH`.
60-
- We use [golangci-lint](https://github.com/golangci/golangci-lint) to lint our code, you can install it locally via `make setup`.
58+
- Clone your fork locally.
59+
- Set up your development environment:
60+
- We use Go Modules to manage dependencies, so you can develop outside your `$GOPATH`.
61+
- Run `make setup` to install required dependencies and developer tools including [golangci-lint](https://github.com/golangci/golangci-lint), which we use to lint our code.
6162

6263
### Building and Testing
6364

6465
The following is a short list of commands that can be run in the root of the project directory
6566

66-
- Run `make` see a list of available targets.
67+
- Run `make` to see a list of available targets.
6768
- Run `make test` to run all unit tests.
6869
- Run `make lint` to validate against our linting rules.
6970
- Run `E2E_TAGS=e2e,atlas make e2e-test` will run end-to-end tests against an Atlas instance,
@@ -87,36 +88,41 @@ Please add the following line to your settings.json file :
8788
"go.testTags": "unit,e2e"
8889
```
8990

90-
This will enable compilation for unit test and end-to-end tests.
91+
This will enable compilation for unit and end-to-end tests.
9192

9293
#### Debugging in VSCode
9394

94-
To debut in VSCode you need to create a debug configuration for the command with required arguments.
95-
Run the following commands to
95+
To debug in VSCode, you must create a debug configuration for the command with the required arguments.
96+
Run the following commands to create a new launch.json file for the debugger:
9697

9798
```
9899
touch .vscode/launch.json
99100
```
100-
Then put the following configuration into the file.
101-
Review and replace command name and arguments depending on the command you are using.
101+
Then put the following example configuration into the file.
102+
Review and replace the command name and arguments depending on the command you want to debug.
102103

103104
```json
104105
{
105106
"configurations": [
106107
{
107-
"name": "Login Command",
108+
"name": "DBuser Create Command",
108109
"type": "go",
109110
"request": "launch",
110111
"mode": "auto",
111112
"program": "${workspaceFolder}/cmd/atlas",
112113
"env": {},
113114
"args": [
114-
"login"
115+
"dbuser",
116+
"create",
117+
"atlasAdmin",
118+
"--username",
119+
"myUser",
120+
"--password",
121+
"123abc"
115122
]
116123
}
117124
]
118125
}
119-
120126
```
121127

122128
### Contributing New Command Group
@@ -145,7 +151,7 @@ For example please edit `./root/atlas/builder.go` to add your command builder me
145151
### Adding a New Command
146152

147153
`atlas` has defined a basic structure for individual commands that should be followed.
148-
For a `atlas scope newCommand` command, a file `internal/cli/scope/new_command.go` should implement:
154+
For an `atlas scope newCommand` command, a file `internal/cli/scope/new_command.go` should implement:
149155

150156
- A `ScopeNewCommandOpts` struct which handles the different options for the command.
151157
- At least a `func (opts *ScopeNewCommandOpts) Run() error` function with the main command logic.

0 commit comments

Comments
 (0)