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

Add methods supporting teamID to usergroups #37

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

marthaklambert
Copy link

  • If you're using enterprise grid, sending a teamID along with a usergroup is required for all API methods
  • Previously, very few of the usergroup methods in this client supported teamID
  • I've added separate methods, to avoid breaking changes, which take a teamID
Pull Request Guidelines

These are recommendations for pull requests.
They are strictly guidelines to help manage expectations.

PR preparation

Run make pr-prep from the root of the repository to run formatting, linting and tests.

Should this be an issue instead
  • is it a convenience method? (no new functionality, streamlines some use case)
  • exposes a previously private type, const, method, etc.
  • is it application specific (caching, retry logic, rate limiting, etc)
  • is it performance related.
API changes

Since API changes have to be maintained they undergo a more detailed review and are more likely to require changes.

  • no tests, if you're adding to the API include at least a single test of the happy case.
  • If you can accomplish your goal without changing the API, then do so.
  • dependency changes. updates are okay. adding/removing need justification.
Examples of API changes that do not meet guidelines:
  • in library cache for users. caches are use case specific.
  • Convenience methods for Sending Messages, update, post, ephemeral, etc. consider opening an issue instead.

- If you're using enterprise grid, sending a teamID along with a usergroup is required for all API methods
- Previously, very few of the usergroup methods in this client supported teamID
- I've added separate methods, to avoid breaking changes, which take a teamID
@marthaklambert marthaklambert force-pushed the martha/support-teamid-in-usergroup-methods branch from 780ce96 to ffc8fc2 Compare November 25, 2024 17:28
@marthaklambert marthaklambert merged commit a45849a into master Nov 25, 2024
2 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants