Skip to content

docs(contribution): add Feedback/Issues #1338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2021
Merged

docs(contribution): add Feedback/Issues #1338

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6abade3
add a section about Feedback/Issues in the Contributing File
soniasingla Jul 6, 2021
16713e0
Merge branch 'develop' into new-sec
fadeev Jul 9, 2021
1c0f3b2
Merge branch 'develop' into new-sec
fadeev Jul 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ Start a new [Discussion](https://github.com/tendermint/starport/discussions/new)

Thank you for your contribution!

## Opening pull requests
## Providing Feedback

* Before you open an issue, do a web search, and check for [existing open and closed GitHub Issues](https://github.com/tendermint/starport/issues) to see if your question has already been asked and answered. If you find a relevant topic, you can comment on that issue.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about navigating users to the Discussions page instead and only use issues for direct bug reports and feature requests?

So, basially, we can convert these three bullets in two, first one saying that "please open a discussion or comment to an existent one for your questions, feedbacks, ideas or use the Discord channel for quick responses."

Second, "please create issues from this link to report a bug or ask for a feature request."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ilgooz Discussions pages are great alternative but our large user-base/community is over Discord, it supports group voice channels if needed + Screen sharing available in groups!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC, the Discussions page provides a repo-based home... I like @ilgooz's proposal. I had forgotten about using Discussions. @soniasingla wdyt about sending folks from Discord to Discussions? (I seem to remember a conversation about centralizing feedback in GitHub). In this case, @ilgooz suggestions make sense.
I was just reading up on Discussions https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/about-discussions
So in this case, it depends on the dev team and how they want to capture the user feedback. Big opportunities!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll think about Discord vs alternatives later. Right now Discord has traction, so we're using that. If people will start using discussions (it's open for them now), we might reconsider.

* To provide feedback or ask a question, create a [GitHub issue](https://github.com/tendermint/starport/issues/new/choose). Be sure to provide the relevant information, case study, or informative links as suggested by the Pull Request template.
* We recommend using GitHub issues for issues and feedback. However, you can ask quick questions on the [#🔨cosmos-sdk-starport](https://discord.com/channels/669268347736686612/737461683588431924) channel in Discord.

## Opening pull requests

### Choose a good PR title

Expand All @@ -22,7 +28,7 @@ Make sure that you manually tested the changes you're introducing before creatin

Monitor your PR to make sure that all CI checks pass and the PR shows **All checks have passed** (the checkmark is green).

### Avoid rebasing commits in your branch
### Avoid rebasing commits in your branch

Avoid rebasing after you open your PRs to reviews. Instead, add more commits to your PR. It's OK to do force pushes if the PR is still in draft mode and was never opened to reviews before.

Expand All @@ -32,7 +38,7 @@ Don't worry about adding too many commits. The commits are squashed into a singl

### Ask for help

If you started a PR but couldn't finish it for whatever reason, don't give up. Instead, just ask for help. Someone else can take over and assume the ownership.
If you started a PR but couldn't finish it for whatever reason, don't give up. Instead, just ask for help. Someone else can take over and assume the ownership.

We appreciate every bit of your work!

Expand Down