Skip to content

Commit 4f48b0e

Browse files
Add CONTRIBUTING.md and remove roadmap
1 parent a8b5b4f commit 4f48b0e

File tree

3 files changed

+23
-24
lines changed

3 files changed

+23
-24
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to the STM32-base project documentation
2+
3+
Thank you for showing interest in contributing to the STM32-base project documentation!
4+
5+
## Scope
6+
7+
The scope of the STM32-base documentation is broad. It can be divided in four categories:
8+
9+
- Guides and concept pages on Arm Cortex-M cores
10+
- Guides and concept pages on STM32 microcontrollers and development boards
11+
- Guides and concept pages specific to STM32-base
12+
- Guides and concept pages on other projects supporting STM32 microcontrollers
13+
14+
The last category is a special one. Guides and concept pages on other projects are allowed. However, maintaining these pages will be a responsibility of their author or their project's team.
15+
16+
## Reporting an issue
17+
18+
Issues must be reported on Github. You can create an issue for (spelling) errors, ideas, features, and questions. Issues found in the STM32-base project itself must be reported on the [STM32-base repository](https://github.com/STM32-base/STM32-base).
19+
20+
## Creating a pull request
21+
22+
If you are able to fix or add something yourself, please do so! You can proceed without reporting an issue for small fixes or for new pages. Please report an issue if you want to work on something bigger.

general/roadmap.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ The STM32-base project is divided over multiple Github repositories. See the [pr
2626

2727
## Contributing
2828

29-
Refer to the [`CONTRIBUTING.md`](https://github.com/STM32-base/STM32-base/blob/master/CONTRIBUTING.md) file to learn more about contributing to the STM32-base project. Take a look at the [roadmap]({{ site.url }}/general/roadmap) if you are looking for things to work on.
29+
Refer to the [`CONTRIBUTING.md`](https://github.com/STM32-base/STM32-base/blob/master/CONTRIBUTING.md) file of the STM32-base repository to learn more about contributing to the STM32-base project. Refer to the [`CONTRIBUTING.md`](https://github.com/STM32-base/STM32-base.github.io/blob/master/CONTRIBUTING.md) file of the STM32-base project documentation repository to learn more about contributing to this documentation website.

0 commit comments

Comments
 (0)