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.

Sign up for GitHub

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

DOC: chat-ops #38754

Merged
merged 5 commits into from
Dec 30, 2020
Merged

DOC: chat-ops #38754

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f1b72b
Fixes #38726
1nF0rmed Dec 28, 2020
3bfe3f4
DOC: chat-ops (#38726)
1nF0rmed Dec 28, 2020
5ae8045
Minor changes
1nF0rmed Dec 29, 2020
6e77fe9
Minor changes to documentation
1nF0rmed Dec 29, 2020
ab7ff99
Moving autofixing section to contributing.rst
1nF0rmed Dec 29, 2020
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
22 changes: 22 additions & 0 deletions doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1610,6 +1610,28 @@ request by pushing to the branch on GitHub::

git push origin shiny-new-feature

Autofixing formatting errors
----------------------------

We use several styling checks(e.g. ``black``, ``flake8``, ``isort``) which are run after
rhshadrach marked this conversation as resolved.
Show resolved Hide resolved
you make a pull request. If there is a scenario where any of these checks fail then you
can comment::

@githubactions pre-commit
Copy link
Member

Choose a reason for hiding this comment

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

this should be

Suggested change
@githubactions pre-commit
@github-actions pre-commit

, I missed out the - in the issue


on that pull request. This will trigger a workflow which will autofix formatting errors.

Backporting (optional)
Copy link
Contributor

Choose a reason for hiding this comment

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

this should only be in the maintainers section (i think we have one?)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, doc/source/development/maintaining.rst - @1nF0rmed could you move this over there please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does that include the backporting section?

Copy link
Member

@MarcoGorelli MarcoGorelli Dec 29, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

yes, the whole part about @meeseeksdev backport should be in the maintainers section

----------------------

In the case you want to apply changes to a stable branch from a newer branch then you
can comment::

@meeseeksdev backport

This will trigger a workflow which will backport a given change to a branch
(e.g. ``@meeseeksdev backport 1.2.x``)
rhshadrach marked this conversation as resolved.
Show resolved Hide resolved

Delete your merged branch (optional)
------------------------------------

Expand Down