MkPullRequestGuidelines

Show source on GitHub

Node showing pull request guidelines.

ExamplesDocStringsBase classes⋔ Inheritance diagramNodeFileCode

Bases: MkTemplate

__init__

__init__(**kwargs: Any)

Parameters:

Name	Type	Description	Default
kwargs	Any	Keyword arguments passed to parent	{}

Name	Children	Inherits
MkTemplate mknodes.templatenodes.mktemplate Node representing a jinja template.	MkCliDoc MkMaterialBadge MkImageCompare MkImageSlideshow MkIFrame MkCard MkInstallGuide MkCodeOfConduct MkCommitConventions MkPullRequestGuidelines MkDevEnvSetup ...	MkContainer

graph TD
  94721312199616["mkpullrequestguidelines.MkPullRequestGuidelines"]
  94721308869584["mktemplate.MkTemplate"]
  94721311697232["mkcontainer.MkContainer"]
  94721308848336["mknode.MkNode"]
  94721311766592["node.Node"]
  140564252373184["builtins.object"]
  94721308869584 --> 94721312199616
  94721311697232 --> 94721308869584
  94721308848336 --> 94721311697232
  94721311766592 --> 94721308848336
  140564252373184 --> 94721311766592

/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkpullrequestguidelines/metadata.toml

[metadata]
name = "MkPullRequestGuidelines"
icon = "octicon:git-pull-request-24"
group = "documentation"

# [examples.regular]
# title = "Regular"
# jinja = """
# {{ mk.MkPullRequestGuidelines() }}
# """

[output.markdown]
template = """
Link to any related issue in the Pull Request message.

During the review, we recommend using fixups:

{{ "git commit --fixup=SHA # SHA of commit you want to fix" | MkCode }}

Once all the changes are approved, you can squash your commits:

{{ "git rebase -i --autosquash main" | MkCode }}

And force-push:

{{ "git push -f" | MkCode }}

If this seems all too complicated, you can push or force-push each new commit,
and we will squash them ourselves if needed, before merging.
"""

class MkPullRequestGuidelines(mktemplate.MkTemplate):
    """Node showing pull request guidelines."""

    ICON = "octicons/git-pull-request-24"

    def __init__(self, **kwargs: Any):
        """Constructor.

        Args:
            kwargs: Keyword arguments passed to parent
        """
        super().__init__(template="pullrequest_guidelines.jinja", **kwargs)