Skip to content

Commit e4f8534

Browse files
authored
Enhance CONTRIBUTING.md with developer resources
Added important developer information and links to CONTRIBUTING.md to assist contributors.
1 parent 79ecffe commit e4f8534

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ We'll work with you to refine your contribution, but we'll also push back if som
99

1010
Here are a few suggestions to make it easier for you to contribute:
1111

12+
### Important Developer Infos
13+
* [Project Structure, Files and Directories](https://github.com/wled/WLED/blob/main/.github/copilot-instructions.md#project-branch--release-structure)
14+
* [Instructions for creating usermods](https://github.com/wled/WLED/blob/main/.github/copilot-instructions.md#adding-a-new-usermod)
15+
* KB: [Compiling WLED](https://kno.wled.ge/advanced/compiling-wled/) - slightly outdated but still helpful :-)
16+
* [Compiling in VSCode/Platformio](https://github.com/wled/WLED-Docs/issues/161) - modern way without command line or platformio.ini changes.
17+
* If you add a new feature, consider making a PR to [``wled-docs``](https://github.com/wled/WLED-Docs) for updating our official documentation.
18+
1219
### PR from a branch in your own fork
1320
Start your pull request (PR) in a branch of your own fork. Don't make a PR directly from your main branch.
1421
This lets you update your PR if needed, while you can work on other tasks in 'main' or in other branches.
@@ -20,7 +27,6 @@ This lets you update your PR if needed, while you can work on other tasks in 'ma
2027
>
2128
> <img width="295" height="134" alt="image: fork and edit" src="https://github.com/user-attachments/assets/f0dc7567-edcb-4409-a530-cd621ae9661f" />
2229
23-
2430
### Target branch for pull requests
2531

2632
Please make all PRs against the `main` branch.

0 commit comments

Comments
 (0)