You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Remove the link to discord
Why: our discord has been sunset in favor of https://forums.percona.com
* chore: remove discord links
* ci: refactor some actions
* ci: refactor go.yml
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,4 +9,4 @@
9
9
-[ ] Update jira ticket description if needed.
10
10
-[ ] Attach screenshots/console output to confirm new behavior to jira ticket, if applicable.
11
11
12
-
Once all checks pass and the code is ready for review, please add `pmm-review-exporters` team as the reviewer. That would assign people from the review team automatically. Report any issues on our [Forum](https://forums.percona.com) or [Discord](https://per.co.na/discord).
12
+
Once all checks pass and the code is ready for review, please add `pmm-review-exporters` team as the reviewer. That would assign people from the review team automatically. Report any issues on our [Forum](https://forums.percona.com).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,6 @@ If you find a bug in Percona MongoDB Exporter and it is not related to PMM, plea
22
22
23
23
Your first step should be to search [GH issues](https://github.com/percona/mongodb_exporter/issues) and [JIRA PMM issues](https://jira.percona.com/issues/?jql=project=PMM%20AND%20component=MongoDB_Exporter) for the existing set of open tickets for a similar report. If you find that someone else has already reported your problem, then you can upvote that report to increase its visibility.
24
24
25
-
26
25
### Submitting PMM Bug
27
26
28
27
If there is no existing PMM report for the issue that relates to PMM, submit a report following these steps:
@@ -35,13 +34,15 @@ An excellent resource is [Elika Etemad's article on filing good bug reports.](ht
35
34
36
35
As a general rule of thumb, please try to create bug reports that are:
37
36
38
-
-*Reproducible.* Include steps to reproduce the problem.
39
-
-*Specific.* Include as much detail as possible: which version, what environment, etc.
40
-
-*Unique.* Do not duplicate existing tickets.
41
-
-*Scoped to a Single Bug.* One bug per report.
37
+
-_Reproducible._ Include steps to reproduce the problem.
38
+
-_Specific._ Include as much detail as possible: which version, what environment, etc.
Please submit your changes against `main` branch, if the fix is needed for the patch or minor release - please ask maintainers to cherry pick it into the release branch.
57
57
58
58
## Setup your local development environment
@@ -69,7 +69,7 @@ These are these available options:
69
69
|format|Format source code|
70
70
|check|Run checks/linters|
71
71
|check-license|Check license in headers. |
72
-
|help|Display this help message. |
72
+
|help|Display this help message. |
73
73
|test|Run all tests (need to start the sandbox first)|
74
74
|test-cluster|Starts MongoDB test cluster. Use `env var TEST_MONGODB_IMAGE` to set flavor and version. Example:|
75
75
||`TEST_MONGODB_IMAGE=mongo:3.6 make test-cluster`|
@@ -78,28 +78,32 @@ These are these available options:
78
78
### Initializing the development environment
79
79
80
80
First you need to have `Go` and `Docker` installed on your system and then, in order to install tools to format, test and build the exporter, you need to run this command:
81
+
81
82
```
82
83
make init
83
84
```
85
+
84
86
It will install `goimports`, `goreleaser`, `golangci-lint` and `reviewdog`.
85
87
86
88
## Tests
87
89
88
90
### Starting the sandbox
89
91
90
92
The testing sandbox starts `n` MongoDB instances as follows:
93
+
91
94
- 3 Instances for shard 1 at ports 17001, 17002, 17003
92
95
- 3 instances for shard 2 at ports 17004, 17005, 17006
93
96
- 3 config servers at ports 17007, 17008, 17009
94
97
- 1 mongos server at port 17000
95
98
- 1 stand alone instance at port 27017
96
99
97
100
All instances are currently running without user and password so for example, to connect to the **mongos** you can just use:
101
+
98
102
```
99
103
mongo mongodb://127.0.0.1:17001/admin
100
104
```
101
-
The sandbox can be started using the provided Makefile using: `make test-cluster` and it can be stopped using `make test-cluster-clean`.
102
105
106
+
The sandbox can be started using the provided Makefile using: `make test-cluster` and it can be stopped using `make test-cluster-clean`.
103
107
104
108
### Running tests
105
109
@@ -120,4 +124,4 @@ After submitting your PR please add `pmm-review-exporters` team as a reviewer -
120
124
121
125
Once your pull request is merged, you are an official Percona Community Contributor. Welcome to the community!
122
126
123
-
We're looking forward to your contributions and hope to hear from you soon on our [Forums](https://forums.percona.com) and [Discord](https://discord.gg/mQEyGPkNbR).
127
+
We're looking forward to your contributions and hope to hear from you soon on our [Forums](https://forums.percona.com).
0 commit comments