Skip to content

Commit 6ad7fd6

Browse files
authored
Added "Where to Contribute"
1 parent afbc04a commit 6ad7fd6

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/CONTRIBUTING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,24 @@ What to Contribute
22
==================
33
Goals of this Arduino core, listed in order of priority, are:
44
1. Coverage of the Arduino built-in functions demonstrated by Sketch compatibility.
5-
2. Efficient use of existing AmbiqSuite HAL code
6-
3. Backward-compatible improvements to the standard Arduino libraries
5+
1. Creation of a well-structured and easy to extend Arduino core.
6+
1. Efficient use of existing AmbiqSuite HAL code.
7+
1. Backward-compatible improvements to the standard Arduino libraries.
78

89
If you find a standard Arduino capability that is not working then that is a great candidate for a contribution.
910

11+
Where to Contribute
12+
===================
13+
In keeping with the goal of creating a well-structured, easy to understand, and easy to extend Arduino core it is importatnt to carefully consider where new code should be located.
14+
15+
There are two main places where you might add code:
16+
1. The core ```Arduino_Apollo3\cores\arduino```
17+
2. Variants ```Arduino_Apollo3\variants```
18+
19+
Code that goes in the core should be applicable to *any* Apollo3-based board as opposed to code that is specific to a particular variant.
20+
21+
Within the core the majority of work will take place under the Arduino Support folder ```Arduino_Apollo3\cores\arduino\ard_sup```.
22+
1023
How to Contribute
1124
=================
1225

0 commit comments

Comments
 (0)