Changes between Version 23 and Version 24 of Developer/Contributing


Ignore:
Timestamp:
Nov 22, 2014, 5:11:43 AM (5 years ago)
Author:
Chris Johns
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Contributing

    v23 v24  
    2323= Description =
    2424
    25 For new features include a description of the feature and your design/implementation. For bugs a reference to a [wiki:Bugzilla bug report] should be included.
     25For new features include a description of the feature and your design/implementation. For bugs a reference to a [wiki:TBR/Review/RTEMS_Bugzilla bug report] should be included.
    2626
    2727If you cannot follow the recommendations of the RTEMS coding conventions, you should include a justification for why. If you are submitting a port of code from another free software project, then that code should NOT be reformatted for RTEMS.  It needs to stay as close to the original source as possible to ease future update efforts.
     
    4242A patch is a text file containing the difference between an old and new version of code. Patches against current development (git head) are preferred to patches against releases unless your patch is intended as a bug fix candidate for a release branch. Send one patch for each logical change made. Each patch you submit should be impossible to subdivide into more patches because of dependencies between the changed parts. Patches that fix code formatting to conform to [wiki:Developer/Coding/Conventions our standards] are best not mixed with substantive changes and vice versa, because the code reformatting hides the functional changes.
    4343
    44 See [wiki:Git_Users#Creating_a_Patch  Creating a Patch] for details on how to use Git to create patches.
     44See [wiki:Developer/GitUsers#CreatingaPatch  Creating a Patch] for details on how to use Git to create patches.
    4545
    4646If you do not have the Git repository available then you can use the diff program to create a patch by comparing an unmodified RTEMS against the version containing your changes with ''diff -up rtems rtems-new'' and redirect the output to a file.
    4747
    48 We prefer patches posted as plain text. If the patch is too big posting it gzipped is acceptable but it would be better as a branch that can be pulled/reviewed. Submit your patch to the [wiki:RTEMSMailingLists_  rtems-devel mailing list] and if the patch fixes a bug, file a PR on the [wiki:Bugzilla Bugzilla].
     48We prefer patches posted as plain text. If the patch is too big posting it gzipped is acceptable but it would be better as a branch that can be pulled/reviewed. Submit your patch to the [wiki:TBR/Website/RTEMSMailingLists mailing list] and if the patch fixes a bug, file a PR on the [wiki:TBR/Review/RTEMS_Bugzilla Bugzilla].
    4949= Submitting =
    5050
    5151
    52 When you have all these pieces [wiki:Git_Users#Submitting_a_Patch email them to the developers mailing list] or post a [wiki:Bugzilla bug report]. All patches and related discussion should be sent to the rtems-devel mailing list. For further information on the RTEMS Git repository, see [wiki:Git Git].
     52When you have all these pieces [wiki:Developer/GitUsers#SubmittingaPatch email them to the developers mailing list] or post a [wiki:TBR/Review/RTEMS_Bugzilla bug report]. All patches and related discussion should be sent to the rtems-devel mailing list. For further information on the RTEMS Git repository, see [wiki:Git Git].
    5353
    5454If you do not receive a response to a patch within a month or so, send a follow-up email. Patches occasionally fall through the cracks. Please be sure to include the URL of the entry in the mailing list archive of the original submission.
     
    6060Firstly, thanks for your interest in contributing! There's plenty you can do to help - and you don't need to be an expert coder, either.
    6161
    62 Don't be afraid to announce your interest on the [wiki:RTEMSMailingLists_ rtems-users mailing list] or to ask questions to help you along!
     62Don't be afraid to announce your interest on the [wiki:TBR/Website/RTEMSMailingLists rtems-users mailing list] or to ask questions to help you along!
    6363
    6464Here're some ideas for work that'd be really useful to RTEMS users. It's non-exhaustive, and largely cobbled together from what's been suggested over time (in fact, one way you might contribute is to update this list with ideas that (for example) have been raised on the mailing lists).
    6565
    66 See also the [wiki:OpenProjects_  Open Projects] page.
     66See also the [wiki:Developer/OpenProjects  Open Projects] page.
    6767= Non-coding =
    6868
     
    7474  *  Translate documentation
    7575  *  Migrate documentation, "where appropriate", from a Wiki article to more formal documents, such as the [http://rtems.org/onlinedocs/doc-current/share/rtems/pdf/started.pdf RTEMS Getting Started] guide
    76   *  Update the RTEMS Wiki, which can be a relatively accessible way to have a significant impact on the RTEMS community, particularly assisting new users. First, [wiki:Special:RequestAccount_  Request a Wiki account], then, for instance:
     76  *  Update the RTEMS Wiki, which can be a relatively accessible way to have a significant impact on the RTEMS community, particularly assisting new users. First, [https://devel.rtems.org/register register an account], then, for instance:
    7777   *  Add "How To" articles on:
    7878   * * Application build systems (might be easier with some coding knowledge) - [http://en.wikipedia.org/wiki/Make_%28software%29 Make] and [http://code.google.com/p/waf WAF] templates, examples and walkthroughs, for instance, can really help new users find their feet and develop the foundation for the application afresh
     
    8181   *  Peruse the [http://www.rtems.org/pipermail/rtems-users rtems-users mailing list archives] for areas in need of clarification
    8282  *  The [http://rtems.org/onlinedocs/doc-current/share/rtems/pdf/started.pdf RTEMS Getting Started] guide
    83    *  Doesn't mention the (very helpful) [wiki:RTEMS_Source_Builder_  RTEMS Source Builder]
     83   *  Doesn't mention the (very helpful) [wiki:TBR/UserManual/RTEMS_Source_Builder  RTEMS Source Builder]
    8484   *  Is generally a bit thin in the post-RTEMS-setup stages, perhaps where it matters most!
    8585   *  Doesn't explain that RTEMS is a library that an application is linked against to create a single binary - this can be confusing for users of other RTOSs that operate differently
     
    9595  *  Look at the Google Code In RTEMS tasks from 2013 for inspiration - http://www.google-melange.com/gci/tasks/google/gci2013 (filter by "RTEMS" in the ''Organisation'' field)
    9696 *  User assistance
    97   *  Hang out on the [wiki:RTEMS_IRC_  RTEMS IRC channel], subscribe to the [wiki:RTEMSMailingLists_  rtems-users mailing list] and assist others where you can
     97  *  Hang out on the [wiki:Developer/IRC  RTEMS IRC channel], subscribe to the [wiki:TBR/Website/RTEMSMailingLists  rtems-users mailing list] and assist others where you can
    9898 *  Fix build warnings - build RTEMS, note, address any submit patches for warnings that are generated
    9999 *  Larger, longer-term projects: