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
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+15-2Lines changed: 15 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,24 @@ What to Contribute
2
2
==================
3
3
Goals of this Arduino core, listed in order of priority, are:
4
4
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.
7
8
8
9
If you find a standard Arduino capability that is not working then that is a great candidate for a contribution.
9
10
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```.
0 commit comments