Skip to content

Commit 05e2e32

Browse files
committed
chore(docs): enhance contributing guide
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
1 parent 66d28ab commit 05e2e32

1 file changed

Lines changed: 29 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ To report a bug/request please file an issue in the right repository
1010
But check the following boxes before posting an issue:
1111

1212
- [ ] `Make sure you are using the latest STM32 core and libraries versions.` See [latest core here](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest).
13-
- [ ] `Your issue is NOT a question/feedback/suggestions.` This should be discussed on the [stm32duino forum](http://stm32duino.com):
14-
* questions on the [STM32 Core](http://stm32duino.com/viewforum.php?f=35).
15-
* bugs/enhancements on the [STM core: Bugs and enhancements](http://stm32duino.com/viewforum.php?f=38).
13+
- [ ] `Your issue is NOT a question/feedback/suggestions.` This should be discussed on the:
14+
* [stm32duino Github discussions](https://github.com/orgs/stm32duino/discussions)
15+
* [stm32duino forum](http://stm32duino.com):
16+
* questions on the [STM32 Core](http://stm32duino.com/viewforum.php?f=35).
17+
* bugs/enhancements on the [STM core: Bugs and enhancements](http://stm32duino.com/viewforum.php?f=38).
1618
- [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed on the forum` See [stm32duino forum](http://stm32duino.com).
1719
- [ ] `Make sure you are working on the right repository.` See the table below.
1820

@@ -97,6 +99,28 @@ When your pull request is stale, you will need to rebase your branch on the curr
9799

98100
More information about rebasing can be found at the repository of [edX](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request).
99101

100-
### 6. Merged!
101-
When your pull request is merged please update the documentation if the changes require it
102+
### 6. Validate the change
103+
Run the checks relevant to the files you changed and include the commands and important results in the pull request description.
104+
105+
- Documentation changes must pass the strict MkDocs build (see the [documentation workflow](docs/development/Documentation-workflow.md) to set up the environment):
106+
```console
107+
"$HOME/.venvs/stm32duino-docs/bin/mkdocs" build --strict
108+
```
109+
- Changes under `cores/`, `libraries/` or `variants/` must pass the AStyle check (see [Code style](docs/development/Astyle.md)):
110+
```console
111+
python3 CI/astyle/astyle.py -g
112+
```
113+
- For source changes, also run the applicable build, example or test checks for the affected board families.
114+
115+
### 7. Merged!
116+
When your pull request is merged please update the related documentation if the change affects user-facing behavior, supported boards, examples, build options, or upload and debugging workflows.
102117
[Documentation](https://stm32duino.github.io/)
118+
119+
### Development guides
120+
Use the guide that matches the type of change:
121+
122+
- [Using the Git repository](docs/development/Using-git-repository.md): how to work with a local core checkout.
123+
- [Adding a board variant](docs/development/Add-a-new-variant/overview.md): new generic and dedicated board variants.
124+
- [Code style and AStyle](docs/development/Astyle.md): required formatting and local validation commands.
125+
- [Documentation workflow](docs/development/Documentation-workflow.md): how to edit, build, preview, and publish documentation.
126+
- [Source locations](docs/development/Where-are-sources.md): the main core and board-package directories.

0 commit comments

Comments
 (0)