Skip to content

Commit 84023a4

Browse files
committed
Merge remote-tracking branch 'origin' into release/v1.46.2
2 parents 73a379c + 78cae54 commit 84023a4

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
files a PR. This is only suitable for really small changes like: spelling fixes, variable name changes or error string
44
change etc. For larger commits, following steps are recommended.
55
* (Optional) If you want to discuss your implementation with the users of GoFr, use the GitHub discussions of this repo.
6-
* Configure your editor to use goimport and golangci-lint on file changes. Any code which is not formatted using these
6+
* Configure your editor to use goimports and golangci-lint on file changes. Any code which is not formatted using these
77
tools, will fail on the pipeline.
88
* Contributors should begin working on an issue only after it has been assigned to them. To get an issue assigned, please comment on the GitHub thread
99
and request assignment from a maintainer. This helps avoid duplicate or conflicting pull requests from multiple contributors.
1010
* Issues labeled triage are not open for direct contributions. If you're interested in working on a triage issue, please reach out to the maintainers
11-
to discuss it before proceeding in the Github thread.
11+
to discuss it before proceeding in the GitHub thread.
1212
<!-- spellchecker:off "favour" have to be ignored here -->
1313
* We follow **American English** conventions in this project (e.g., *"favor"* instead of *"favour"*). Please keep this consistent across all code comments, documentation, etc.
1414
<!-- spellchecker:on -->
15-
* All code contributions should have associated tests and all new line additions should be covered in those testcases.
15+
* All code contributions should have associated tests and all new line additions should be covered in those test cases.
1616
No PR should ever decrease the overall code coverage.
17-
* Once your code changes are done along with the testcases, submit a PR to development branch. Please note that all PRs
17+
* Once your code changes are done along with the test cases, submit a PR to development branch. Please note that all PRs
1818
are merged from feature branches to development first.
1919
* PR should be raised only when development is complete and the code is ready for review. This approach helps reduce the number of open pull requests and facilitates a more efficient review process for the team.
2020
* All PRs need to be reviewed by at least 2 GoFr developers. They might reach out to you for any clarification.
@@ -50,7 +50,6 @@ func TestFunctionName(t *testing.T) {
5050
```
5151

5252

53-
5453
4. **Table-Driven Tests:**
5554

5655
- Consider using table-driven tests for testing multiple scenarios.
@@ -61,6 +60,8 @@ func TestFunctionName(t *testing.T) {
6160
```console
6261
docker run --name mongodb -d -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=user -e MONGO_INITDB_ROOT_PASSWORD=password mongodb/mongodb-community-server:latest
6362
docker run -d -p 21:21 -p 21000-21010:21000-21010 -e USERS='user|password' delfer/alpine-ftp-server
63+
```
64+
6465
# the docker image is relatively unstable. Alternatively, refer to official guide of OpenTSDB to locally setup OpenTSDB env.
6566
# http://opentsdb.net/docs/build/html/installation.html#id1
6667
docker run -d --name gofr-opentsdb -p 4242:4242 petergrace/opentsdb-docker:latest

0 commit comments

Comments
 (0)