You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 05e2e32
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+29-5Lines changed: 29 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,11 @@ To report a bug/request please file an issue in the right repository
10
10
But check the following boxes before posting an issue:
11
11
12
12
-[ ]`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:
* 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).
16
18
-[ ]`Make sure your issue is not already reported/fixed on GitHub or discussed on the forum` See [stm32duino forum](http://stm32duino.com).
17
19
-[ ]`Make sure you are working on the right repository.` See the table below.
18
20
@@ -97,6 +99,28 @@ When your pull request is stale, you will need to rebase your branch on the curr
97
99
98
100
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).
99
101
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):
- 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.
102
117
[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