Skip to content
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.

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

Augment Getting Help docs. #170

Merged
merged 6 commits into from
Oct 21, 2024
Merged
Changes from all commits
Commits
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
51 changes: 41 additions & 10 deletions src/pages/community/getting-help.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,64 @@ How to engage with the Pants community.

The [Pants community](/community/members) is friendly, welcoming, and passionate about improving the craft of software engineering. If you need help with anything Pants-related, you've come to the right place. We'd love to hear from you!

## Slack
## How to get help

The best place to become acquainted with Pants community members, exchange informal chat and ask quick questions is at the project's Slack. You can join using [this link](https://docs.google.com/forms/d/e/1FAIpQLSf9zgf-MXRnVDJbrVEST3urqneq7LCcy0zw8qU-GH4hPMn52A/viewform?usp=sf_link).
Pants community members will do their best to answer any respectfully posed questions. General questions about Pants,
its features, language support, roadmap etc. are always welcome!

We encourage you to introduce yourself in the `#welcome` channel!
If you need help debugging a specific problem you're encountering in your repo, then we ask that you help us to help you:

1. First--before you ask for help--use these resources to find and try solutions others have used, posted, or documented, and any ongoing discussions related to your issue:
- Pants [documentation](https://pantsbuild.org/docs)
- Pants [source code](https://github.com/pantsbuild/pants)
- 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 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!

As an open-source project, we always appreciate a willingness to dive in and fix issues yourself (with our guidance), and to provide support to others in the future, once you're a more seasoned Pants user yourself.
This is how open-source projects grow and thrive!

While we generally try to respond to all issues, unfortunately we cannot guarantee a response in every case, due to the volume of requests.
If you would like your support requests to have a greater guarantee of a timely response, or if you would like help directly in a private repo (under NDA)
we invite you to become a [sponsor](https://www.pantsbuild.org/sponsorship) of Pants. Various tiers of sponsorship include the privilege of such extra support attention from Pants maintainers.

Or, if you want consistent help with Pants integration or feature development, you can reach out to one of the [Pants service providers](https://www.pantsbuild.org/spotlight/service-providers) to enquire about their commercial offerings.

## Discussions
## Where to get help

### Slack

The best place to become acquainted with Pants community members, exchange informal chat and ask questions is at the project's Slack. You can join using [this link](https://docs.google.com/forms/d/e/1FAIpQLSf9zgf-MXRnVDJbrVEST3urqneq7LCcy0zw8qU-GH4hPMn52A/viewform?usp=sf_link).

We encourage you to introduce yourself in the `#welcome` channel!

The best place to ask deeper technical questions or hold design discussions is via the project's [GitHub Discussions](https://github.com/pantsbuild/pants). While questions, feedback, and design discussions are equally welcome on Slack, _we encourage you to choose Discussions whenever it's likely other users would benefit from persistent access to the conversation_. GitHub Discussions is indexed by search engines, and its content is retained long-term, so this is opportunity to help your fellow Pants users by making it easier for folks to discover supplementary technical information beyond the [docs](https://pantsbuild.org/docs).
### Discussions

We encourage you to introduce yourself in the [`"welcome"`](https://github.com/pantsbuild/pants/discussions/categories/-welcome) category!
The best place to ask deeper, long-term technical questions or hold design discussions is via the project's [GitHub Discussions](https://github.com/pantsbuild/pants). While questions, feedback, and design discussions are equally welcome on Slack, _we encourage you to choose Discussions whenever it's likely other users would benefit from persistent access to the conversation_. GitHub Discussions is indexed by search engines, and its content is retained long-term, so this is opportunity to help your fellow Pants users by making it easier for folks to discover supplementary technical information beyond the [docs](https://pantsbuild.org/docs).

## Blog
### Blog

Read [blog.pantsbuild.org](https://blog.pantsbuild.org/) to find elaboration on new features, tutorials, reveals of upcoming features, insights into what we're thinking about and working on, case studies, and behind-the-scenes interviews with Pants users and maintainers.

## Mailing list
### Mailing list

You can join the `[email protected]` mailing list [here](https://groups.google.com/forum/#!forum/pants-devel). This is used mostly for announcements and for us to solicit user feedback.

## GitHub Repository
### GitHub Repository

Pants is an open-source software project, developed at [https://github.com/pantsbuild/pants](https://github.com/pantsbuild/pants).

If you discover a bug with Pants or have a feature request, feel free to [file an issue](https://github.com/pantsbuild/pants/issues). Please check first if a similar issue has already been filed; if it has, please comment so that we know to bump the issue in priority.

## YouTube
### YouTube

We also have a [Pants Build YouTube channel](https://www.youtube.com/channel/UCCcfCbDqtqlCkFEuENsHlbQ) with a variety of concise tutorials, introductions to core concepts, and tips. Subscribe to the channel to get notified of additions.

Expand Down
Loading