diff options
-rw-r--r-- | MAINTAINERS | 31 | ||||
-rw-r--r-- | README | 77 |
2 files changed, 88 insertions, 20 deletions
diff --git a/MAINTAINERS b/MAINTAINERS index 10b2d377..0c868f22 100644 --- a/MAINTAINERS +++ b/MAINTAINERS | |||
@@ -1,26 +1,17 @@ | |||
1 | This file contains a list of BSP maintainers for the BSPs contained in | 1 | This file contains a list of BSP maintainers for the BSPs contained in |
2 | the meta-intel repository. | 2 | the meta-intel repository. |
3 | 3 | ||
4 | Please submit any patches against meta-intel BSPs to the meta-intel | 4 | The purpose of this file is to provide contact information for |
5 | mailing list (meta-intel@yoctoproject.org). Also, if your patches are | 5 | specific BSPs and other code contained within meta-intel. You should |
6 | available via a public git repository, please also include a URL to | 6 | address questions and patches for a particular BSP or other code to |
7 | the repo and branch containing your patches as that makes it easier | 7 | the appropriate maintainer listed in this file, cc'ing the meta-intel |
8 | for maintainers to grab and test your patches. | 8 | mailing list. This ensures that your question or patch will be |
9 | 9 | addressed by the appropriate person, and that it will be seen by other | |
10 | If you have problems with or questions about a particular BSP, feel | 10 | users who may be facing similar problems or questions. |
11 | free to contact the maintainer directly (cc:ing the Yocto mailing list | 11 | |
12 | puts it in the archive and helps other people who might have the same | 12 | Please see the top-level README file for guidelines relating to the |
13 | questions in the future), but please try to do the following first: | 13 | details of submitting patches, reporting problems, or asking questions |
14 | 14 | about any of the BSPs or other recipes contained within meta-intel. | |
15 | - look in the Yocto Project Bugzilla | ||
16 | (http://bugzilla.yoctoproject.org/) to see if a problem has | ||
17 | already been reported | ||
18 | |||
19 | - look through recent entries of the meta-intel | ||
20 | (https://lists.yoctoproject.org/pipermail/meta-intel/) and Yocto | ||
21 | (https://lists.yoctoproject.org/pipermail/yocto/) mailing list | ||
22 | archives to see if other people have run into similar problems or | ||
23 | had similar questions answered. | ||
24 | 15 | ||
25 | Descriptions of section entries: | 16 | Descriptions of section entries: |
26 | 17 | ||
@@ -5,3 +5,80 @@ This is the location for Intel maintained BSPs. | |||
5 | 5 | ||
6 | Please see the README files contained in the individual BSP layers for | 6 | Please see the README files contained in the individual BSP layers for |
7 | BSP-specific information. | 7 | BSP-specific information. |
8 | |||
9 | If you have problems with or questions about a particular BSP, please | ||
10 | contact the maintainer listed in the MAINTAINERS file directly (cc:ing | ||
11 | the Yocto mailing list puts it in the archive and helps other people | ||
12 | who might have the same questions in the future), but please try to do | ||
13 | the following first: | ||
14 | |||
15 | - look in the Yocto Project Bugzilla | ||
16 | (http://bugzilla.yoctoproject.org/) to see if a problem has | ||
17 | already been reported | ||
18 | |||
19 | - look through recent entries of the meta-intel | ||
20 | (https://lists.yoctoproject.org/pipermail/meta-intel/) and Yocto | ||
21 | (https://lists.yoctoproject.org/pipermail/yocto/) mailing list | ||
22 | archives to see if other people have run into similar problems or | ||
23 | had similar questions answered. | ||
24 | |||
25 | If you believe you have encountered a bug, you can open a new bug and | ||
26 | enter the details in the Yocto Project Bugzilla | ||
27 | (http://bugzilla.yoctoproject.org/). If you're relatively certain | ||
28 | that it's a bug against the BSP itself, please use the 'Yocto Project | ||
29 | Components: BSPs | meta-intel' category for the bug; otherwise, please | ||
30 | submit the bug against the most likely category for the problem - if | ||
31 | you're wrong, it's not a big deal and the bug will be recategorized | ||
32 | upon triage. | ||
33 | |||
34 | Guidelines for submitting patches | ||
35 | ================================= | ||
36 | |||
37 | Please submit any patches against meta-intel BSPs to the meta-intel | ||
38 | mailing list (meta-intel@yoctoproject.org). Also, if your patches are | ||
39 | available via a public git repository, please also include a URL to | ||
40 | the repo and branch containing your patches as that makes it easier | ||
41 | for maintainers to grab and test your patches. | ||
42 | |||
43 | There are patch submission scripts available that will, among other | ||
44 | things, automatically include the repo URL and branch as mentioned. | ||
45 | Please see the Yocto Project Development Manual sections entitled | ||
46 | 'Using Scripts to Push a Change Upstream and Request a Pull' and | ||
47 | 'Using Email to Submit a Patch' for details. | ||
48 | |||
49 | Regardless of how you submit a patch or patchset, the patches should | ||
50 | at minimum follow the suggestions outlined in the 'How to Submit a | ||
51 | Change' secion in the Yocto Project Development Manual. Specifically, | ||
52 | they should: | ||
53 | |||
54 | - Include a 'Signed-off-by:' line. A commit can't legally be pulled | ||
55 | in without this. | ||
56 | |||
57 | - Provide a single-line, short summary of the change. This short | ||
58 | description should be prefixed by the BSP or recipe name, as | ||
59 | appropriate, followed by a colon. Capitalize the first character | ||
60 | of the summary (following the colon). | ||
61 | |||
62 | - For the body of the commit message, provide detailed information | ||
63 | that describes what you changed, why you made the change, and the | ||
64 | approach you used. | ||
65 | |||
66 | - If the change addresses a specific bug or issue that is associated | ||
67 | with a bug-tracking ID, include a reference to that ID in your | ||
68 | detailed description in the following format: [YOCTO #<bug-id>]. | ||
69 | |||
70 | - Pay attention to line length - please don't allow any particular | ||
71 | line in the commit message to stretch past 72 characters. | ||
72 | |||
73 | - For any non-trivial patch, provide information about how you | ||
74 | tested the patch, and for any non-trivial or non-obvious testing | ||
75 | setup, provide details of that setup. | ||
76 | |||
77 | Doing a quick 'git log' in meta-intel will provide you with many | ||
78 | examples of good example commits if you have questions about any | ||
79 | aspect of the preferred format. | ||
80 | |||
81 | The meta-intel maintainers will do their best to review and/or pull in | ||
82 | a patch or patchset within 24 hours of the time it was posted. For | ||
83 | larger and/or more involved patches and patchsets, the review process | ||
84 | may take longer. | ||