Update CONTRIBUTING.md with link to discord #5311
Conversation
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
|
|
|
How about putting a link to https://www.cypress.io/support/ into the footer of https://docs.cypress.io/ ?
You shouldn't be changing |
There was a problem hiding this comment.
can you please fix the package.lock file? @MikeMcC399 is correct there is no reason this should be updated in this PR.
| We have a thriving community on discord. If you have any questions related to | ||
| contributing please reach out, we'd be happy to help! | ||
| [Join us on discord to start the conversation](https://discord.gg/cypress). |
There was a problem hiding this comment.
| We have a thriving community on discord. If you have any questions related to | |
| contributing please reach out, we'd be happy to help! | |
| [Join us on discord to start the conversation](https://discord.gg/cypress). | |
| We have a thriving community on Discord. If you have any questions related to | |
| contributing please reach out, we'd be happy to help! | |
| [Join us on Discord to start the conversation](https://discord.gg/cypress). |
Discord is written uppercase.
There are different links in use for Cypress on Discord:
is also used in https://github.com/cypress-io/cypress/blob/develop/.github/ISSUE_TEMPLATE/1-bug-report.yml
The support page lists
https://discord.com/invite/cypress
This should be checked, which is the preferred Discord link to be passed on.
There was a problem hiding this comment.
The discord channel is not monitored for helping individuals contribute to Cypress. It would be more appropriate to remove these changes to the Contribution guide & add the Discord chat badge to the README. See: https://github.com/cypress-io/cypress#readme
Also the best link to use is on.cypress.io/chat. This is managed by our team to direct users to the correct invite if/when it expires.
There was a problem hiding this comment.
I was a bit confused about "It would be more appropriate to remove add the Discord chat badge to the README. See: https://github.com/cypress-io/cypress#readme". Did you mean "remove" or "add"?
The README of the main Cypress repo (not the docu repo) contains
which links to https://on.cypress.io/discord
Are you saying that the link in the README should be changed to
https://on.cypress.io/chat
instead?
There was a problem hiding this comment.
Sorry - updated comment. but to clarify - I am suggesting removing the suggested changes to the contribution guide all together and adding the badge to the readme instead.
There was a problem hiding this comment.
I am suggesting removing the suggested changes to the contribution guide all together and adding the badge to the readme instead.
I agree that adding this information to CONTRIBUTING.md is the wrong place. The discussions which take place in Discord are about using Cypress. I have not seen discussions there about contributing to the development of Cypress in terms of PRs to the software or to the documentation.
The README in this (documentation) repo could copy the badge used in the README of the main repo.
Additionally (and probably outside of the scope of this PR), there could be a section "How to get support" added to
- the docu README
- the main Cypress README
- the footer of the docu page https://docs.cypress.io/
each linking to the detailed webpage https://www.cypress.io/support/ how to get support.
| We have a thriving community on discord. If you have any questions related to | ||
| contributing please reach out, we'd be happy to help! | ||
| [Join us on discord to start the conversation](https://discord.gg/cypress). |
There was a problem hiding this comment.
The discord channel is not monitored for helping individuals contribute to Cypress. It would be more appropriate to remove these changes to the Contribution guide & add the Discord chat badge to the README. See: https://github.com/cypress-io/cypress#readme
Also the best link to use is on.cypress.io/chat. This is managed by our team to direct users to the correct invite if/when it expires.
|
@emilyrohrbough I disagree that discord cannot help folks contribute. Lots of folks in there have experience contributing to the repo. So I think it is fine to point folks there for assistance. I do like the idea of using the discord badge. |
|
|
@carlosm-o |
|
|
@carlosm-o Thanks so much for the contribution! It sparked a good discussion and we now have a link to Discord via a badge on the README from #5335. Since this should give folks a good route to the community I'm going to close this PR - lmk if you disagree and we can reopen for further discussion. |
I had an issue with running the application locally and couldn't find where to go for live help other than submitting an issue. I hope this can help other potential contributors reach out to the Cypress community.