Skip to content

Commit 9aa657f

Browse files
authored
docs(contributors): fix warnings (#17)
1 parent c89d0f2 commit 9aa657f

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

docs/guides/guide-contributor/workflow.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ To start working with us, please follow these simple steps:
1515
open to work on anything and we will suggest some issues for you.
1616
5. Once we have added you to our [GitHub organization][elixir-cloud-aai-github],
1717
you can assign yourself to an issue.
18-
6. Please carefully read the [guidelines](#guidelines) below, as well as any
19-
relevant language-specific guidelines in this section.
18+
6. Please carefully read the [guidelines](#general-guidelines) below, as well as
19+
any relevant [language-specific guidelines](language-specific/index.md).
2020
7. Start coding! :computer:
2121

2222
!!! note "Privacy note"
@@ -204,8 +204,12 @@ following **type** prefixes:
204204

205205
### Filing pull requests
206206

207-
**Make sure to follow the [commit message](#commit-messages) rules for your pull
208-
request titles.**
207+
Open pull requests through the GitHub interface, VS Code or your favorite Git
208+
client. Make sure to follow the branching model. Most importantly:
209+
210+
??? warning "Use Conventional Commit messages for your PR titles!"
211+
212+
See details in the [commit message](#commit-messages) section.
209213

210214
#### Code reviews
211215

@@ -316,7 +320,7 @@ root directory:
316320
- **Code of Conduct** in file `CODE_OF_CONDUCT.md` (can link to the [Code of
317321
Conduct](../../about/code-of-conduct.md) on this page)
318322
- **Contributing guidelines** in file `CONTRIBUTING.md` (can link to the
319-
[contributor guide](../index.md) on this page)
323+
[contributor guide](index.md) on this page)
320324
- **License** in file `LICENSE`)
321325
- **Pull request template** in file `PULL_REQUEST_TEMPLATE.md`
322326

@@ -389,7 +393,7 @@ sections (fill in with "Coming soon" if not yet available):
389393
- **Installation**: Instructions on how to install/deploy the project
390394
- **Versioning**: Information on how the project is versioned
391395
- **Contributing**: Guidelines on how to contribute to the project, with links
392-
to the [contributing guidelines](../index.md) and our
396+
to the [contributing guidelines](index.md) and our
393397
[code of conduct](../../about/code-of-conduct.md)
394398
- **Contact**: Information on how to contact the project leads
395399

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ markdown_extensions:
6565
- md_in_html
6666
- pymdownx.details
6767
- pymdownx.emoji:
68-
emoji_index: !!python/name:materialx.emoji.twemoji
69-
emoji_generator: !!python/name:materialx.emoji.to_svg
68+
emoji_index: !!python/name:material.extensions.emoji.twemoji
69+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
7070
options:
7171
custom_icons:
7272
- overrides/.icons

0 commit comments

Comments
 (0)