Skip to content

[Notifier] Update Slack Bridge README.md #50533

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

Closed
wants to merge 1 commit into from
Closed

Conversation

flovntp
Copy link

@flovntp flovntp commented Jun 1, 2023

Q A
Branch? 6.3
Bug fix? no
New feature? no
Deprecations? no
Tickets Fix #...
License MIT
Doc PR symfony/symfony-docs#...

Update README as it looks like unclear for me:

  • Add section to activate Slack transport into notifier.yaml
  • add typehint for $chatter: when using code sample, i needed to inject ChatterInterface dependency to make it works and i was unsure which Service was involved there.

And maybe it's missing: add a link to slack documentation on how to create an API token ?
https://api.slack.com/authentication/basics

* Adding section to activate Slack transport into notifier.yaml
* adding typehint for `$chatter` as i needed to inject its dependency into my service and i was looking for the service class.
@flovntp flovntp requested a review from OskarStark as a code owner June 1, 2023 15:24
@carsonbot carsonbot added this to the 6.3 milestone Jun 1, 2023
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot
Copy link

Hey!

Thanks for your PR. You are targeting branch "6.3" but it seems your PR description refers to branch "6.3 for bug fixes".
Could you update the PR description or change target branch? This helps core maintainers a lot.

Cheers!

Carsonbot

@@ -26,6 +26,16 @@ SLACK_DSN=slack://xoxb-......@default?channel=#my-channel-name
SLACK_DSN=slack://xoxb-......@default?channel=fabien
```

Activate Slack transports into config/packages/notifier.yaml
--------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

The number of dashes should be the same as the line above :)

Copy link
Contributor

Choose a reason for hiding this comment

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

"Activate" -> "Enable"

@welcoMattic welcoMattic changed the title Update README.md [Notifier] Update Slack Bridge README.md Jun 3, 2023
@nicolas-grekas
Copy link
Member

Closing in favor of symfony/recipes#1217, thanks for the idea :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants