Skip to content

Commit

Permalink
Update documentation for using Zulip vs GitHub issues
Browse files Browse the repository at this point in the history
- Recommend use of Zulip for discussion
- Note that if the conversation concludes that changes to the tooling
  are required, a GitHub issues should be created
  • Loading branch information
jafeltra committed Jun 21, 2024
1 parent 998754b commit 2736c43
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions BEST-PRACTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

We're glad you're considering contributing to SUSHI! Below are a few best practices that we recommend for all contributions.

## Before contributing
## Before Contributing

Before contributing a feature or a bugfix, we recommend creating a GitHub issue if one does not exist. This allows the community to provide feedback on why an issue may be occurring or provide additional insight into a suggested feature. See the [Contribution Policy](CONTRIBUTING.md#issues) to learn more about creating issues.
Before contributing a feature or a bugfix, we recommend creating a GitHub issue if one does not exist. This allows the community to provide feedback on why an issue may be occurring or provide additional insight into a suggested feature. See the [Contribution Policy](CONTRIBUTING.md#issues) to learn more about creating issues. It may also be useful, but is not required, to start a Zulip conversation around the feature or bug. See the [Contribution Policy](CONTRIBUTING.md#zulip) to learn more about Zulip.

If a GitHub issue already exists for what you are planning to contribute, we recommend commenting on the issue to indicate that you are working on an implementation to avoid duplication of work.

## Coding practices
## Coding Practices

We recommend the following coding practices for high quality contributions:

Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Before starting a new conversation, please check for earlier discussions on a si

When starting a new conversation, please use a descriptive topic and include as much detail as possible.

If you are looking for feedback or discussion around an issue, we recommend using Zulip. The FSH community is active on Zulip, and it is the best place to have in-depth discussions and ask questions about the FSH tooling. If the discussion on Zulip determines that a change is required in SUSHI, you should create a GitHub issue to track it. The GitHub issue should include a link to the relevant Zulip discussion thread, and it is best practice to provide a link to the GitHub issue on the Zulip thread. While Zulip is very useful for discussion, GitHub issues are the system of record for changes to SUSHI.

## Code Contributions

If you are planning to work on a reported bug, suggestion, or feature request, please comment on the relevant issue to indicate your intent to work on it.
Expand Down

0 comments on commit 2736c43

Please sign in to comment.