good morning!!!!
Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
W
websocket
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Harbor Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
open
websocket
Commits
29412064
Unverified
Commit
29412064
authored
5 years ago
by
Anmol Sethi
Browse files
Options
Downloads
Patches
Plain Diff
Update CONTRIBUTING.md
parent
7a64dc4d
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/CONTRIBUTING.md
+9
-6
9 additions, 6 deletions
docs/CONTRIBUTING.md
with
9 additions
and
6 deletions
docs/CONTRIBUTING.md
+
9
−
6
View file @
29412064
...
...
@@ -20,21 +20,24 @@ on a PR that may be rejected.
You can run tests normally with
`go test`
.
You'll need the
[
Autobahn Test suite pip package
](
https://github.com/crossbario/autobahn-testsuite
)
.
In the future this dependency will be removed. See
[
#117
](
https://github.com/nhooyr/websocket/issues/117
)
.
On submission please check if CI has passed and if not, please correct your code such that it does.
If necessary, you may run CI locally with the
`ci/run.sh`
script.
You'll only need
[
shellcheck
](
https://github.com/koalaman/shellcheck#installing
)
.
If necessary, you may run CI locally with the
`ci/run.sh`
script which will fmt, lint and test your code
with coverage.
You'll need
[
shellcheck
](
https://github.com/koalaman/shellcheck#installing
)
, node and the
Autobahn Test suite linked above.
For coverage details locally, please see
`ci/out/coverage.html`
after running
`ci/run.sh`
or
`ci/test.sh`
.
For remote coverage, you can use either
[
codecov
](
https://codecov.io/gh/nhooyr/websocket
)
or download the
`coverage.html`
generated by the go tooling as an artifact o
n CI.
`coverage.html`
artifact on the test step i
n CI.
You can also run any of the steps individually. All of them are scripts in the
`ci`
directory.
You can also run any of the
CI
steps individually. All of them are scripts in the
`ci`
directory.
See
[
../ci/lint.sh
](
../ci/lint.sh
)
and
[
../ci/test.sh
](
../ci/test.sh
)
for the
installation of shellcheck and the Autobahn test suite on Debian or Ubuntu.
installation of shellcheck
, node
and the Autobahn test suite on Debian or Ubuntu.
For Go, please refer to the
[
offical docs
](
https://golang.org/doc/install
)
.
You can benchmark the library with
`./ci/benchmark.sh`
. You only need Go to run that script. Benchmark
profiles generated by that script are also available
for every CI job as artifacts
.
profiles generated by that script are also available
as artifacts on the bench step
.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment