Skip to content

Commit

Permalink
Update src/pages/community/getting-help.mdx
Browse files Browse the repository at this point in the history
Co-authored-by: Jacob Floyd <cognifloyd@gmail.com>
  • Loading branch information
benjyw and cognifloyd authored Oct 18, 2024
1 parent ec4b654 commit 43d6127
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/pages/community/getting-help.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ If you need help debugging a specific problem you're encountering in your repo,
- Pants [GitHub discussions](https://github.com/pantsbuild/pants/discussions)
- Pants [issue tracker](https://github.com/pantsbuild/pants/issues)
- [Searchable Slack community mirror](https://chat.pantsbuild.org/)
1. If you're still stuck, and would like a Pants contributor to look at your problem, the best way to do so is to provide a small public GitHub repo that reproduces the problem.
The README.md in this repo should provide clear instructions on how to reproduce the problem, and the architecture and OS on which it can be reproduced.
1. Sometimes it's not possible to create a reproducer, e.g., when the issue is performance at scale in a proprietary repo, or a bug related to inconsistent behavior.
In that case, it's still helpful to have as much info as possible, including the contents of `pants.toml` and relevant `BUILD` files, and the exact command line invocation.
1. If the tips and solutions you've tried have not resolved your issue, and you would like a Pants contributor to look at your problem, you need a way to demonstrate your problem.
- The best way to show an issue is to provide a small public GitHub repo that reproduces the problem.
The README.md in this repo should provide clear instructions on how to reproduce the problem, and the architecture and OS on which it can be reproduced.
- Sometimes it's not possible to create a reproducer, e.g., when the issue is performance at scale in a proprietary repo, or a bug related to inconsistent behavior.
In that case, it's still helpful to have as much info as possible, including the contents of `pants.toml` and relevant `BUILD` files, and the exact command line invocation.
1. Either way, then [file an issue](https://github.com/pantsbuild/pants/issues/new/choose) that states the problem and the steps you've taken to attempt to solve it, and a link to the reproducer repo, if you've been able to create one.
If you find an existing issue that seems relevant, please link to it, or post directly to that existing issue if you're reasonably sure it describes the same problem.
1. Finally, reach out in the #general channel in Slack with a summary and a link to your issue, to kickstart the discussion. We're happy to help if we have all the information!
Expand Down

0 comments on commit 43d6127

Please sign in to comment.