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

docs: updated contribution guide #46

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hyder
Copy link
Collaborator

@hyder hyder commented Nov 19, 2021

Signed-off-by: Ali Mukadam [email protected]

@hyder hyder requested a review from snafuz November 19, 2021 07:45
@ttscoff
Copy link
Member

ttscoff commented Nov 19, 2021

Syntax correction: triple backticks should only be used for multi-line fenced code:

```
...code...
```

Inline code spans should always use single backticks surrounding them. Please revise to avoid:

one line ```code``` spans

1. Once your PR has been approved and merged, it's time to do update your local repo.

2. Ensure you are on main:
```git checkout main```
Copy link
Member

Choose a reason for hiding this comment

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

one-line code spans use a single backtick, please. A newline must exist between a parent list item and indented paragraph/code content

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