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 instructions for registering IRC bot's nickname #1004

Merged
merged 3 commits into from
Mar 19, 2020
Merged

Add instructions for registering IRC bot's nickname #1004

merged 3 commits into from
Mar 19, 2020

Conversation

DylanVanAssche
Copy link

@DylanVanAssche DylanVanAssche commented Mar 3, 2020

Setting up your own Matrix IRC bridge might require that you register the nickname of your IRC bot.
Some channels won't allow your bot to join without a registered nickname. As a result, the bot won't be able to join and cannot bridge the channel to Matrix.

This feature is already supported by the bridge, however it was not mentioned in the HOWTO.md guide for rolling your own bridge.

Signed-off-by: Dylan Van Assche dylan.van.assche@protonmail.com

@Half-Shot
Copy link
Contributor

This seems good to me. Thanks 👍

@Half-Shot
Copy link
Contributor

Oh, almost! Can you base your changes against develop please?

@Half-Shot Half-Shot self-assigned this Mar 19, 2020
@DylanVanAssche DylanVanAssche changed the base branch from master to develop March 19, 2020 13:39
@DylanVanAssche
Copy link
Author

Changes based against develop 🚀

@Half-Shot
Copy link
Contributor

Oh and final final thing, as per https://github.com/matrix-org/matrix-appservice-irc/blob/master/CONTRIBUTING.md#making-pull-requests, could you add a changelog file so we can keep track of changes.

Create a changelog entry in changelog.d. A changelog filename should be ${GithubIssueNumber}.{bugfix|misc|feature|doc|removal} The change should include information that is useful to the user rather than the developer.

Rememver to stick your github handle on the end of the changelog file to get credited :)

@DylanVanAssche
Copy link
Author

I don't have a Github Issue, do I need one first? That's also the reason why I skipped the changelog thing when creating this PR

@Half-Shot
Copy link
Contributor

Ah, the issue number is this PR's number (1004). Probably not clear enough in the docs.

@DylanVanAssche
Copy link
Author

Done!

@DylanVanAssche
Copy link
Author

Maybe describe in the guidelines the best 'template' for the changelog entries?

@Half-Shot Half-Shot merged commit b9b8174 into matrix-org:develop Mar 19, 2020
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.

None yet

2 participants