libresoc_bug_process.mdwn

   1 # LibreSOC Bug Process
   2
   3 * [Bug #1126](https://bugs.libre-soc.org/show_bug.cgi?id=1126)
   4
   5 * HDL workflow guide page: [[HDL_workflow]]
   6
   7 This page describes in detail how to raise new tasks (bugs) and how to approach
   8 development within the project in order to get appropriate amount of funding
   9 for the tasks completed.
  10
  11 # Why raise issues
  12
  13 * [Bug #1126](https://bugs.libre-soc.org/show_bug.cgi?id=1126)
  14
  15 If you have discovered a problem in Libre-SOC (software, hardware, etc.),
  16 please raise a bug report!
  17 Bug reports allow tracking of issues, both to make the developers lives easier,
  18 as well as for tracking completed grant-funded work.
  19
  20 It is **extremely** important to link the new bug to previous ones. As Luke
  21 mentioned on [this bug](https://bugs.libre-soc.org/show_bug.cgi?id=1139#c3),
  22 "it is a mandatory project requirement that the graph from any bug
  23 contain all other bugs (one "Group")".
  24
  25 The primary reason for this is to ensure bugs don't get buried and lost,
  26 and will aid those tackling similar problems at a later time.
  27
  28 Also, for project management and financing purposes, it helps developers
  29 to keep an up-to-date list of their tasks.
  30
  31 ##How to raise issues
  32
  33 1. Create a bug report.
  34 2. Add in any links from the mailing list or IRC logs to the bug report for back tracking
  35   (this is mandatory). Also fill in the URL field if there is a relevant wiki page.
  36 3. CC in relevant team members
  37 4. make absolutely sure to fill in "blocks", "depends on" or "see also" so that the
  38    bug is not isolated (otherwise bugs are too hard to find if isolated from everything else)
  39 5. Ping on IRC to say a bug has been created
  40 6. Unless you know exactly which milestone to use, leave blank initially. This
  41 also applies when editing milestone, budget parent/child, toml fields. See
  42 section [[HDL_workflow#Task management guidelines]] further down.
  43 7. After setting the milestone, it is **absolutely required** to run
  44 [budget-sync](https://git.libre-soc.org/?p=utils.git;a=blob;f=README.txt;hb=HEAD),
  45 as it will point out any discrepancies. The budget allocations will be used for
  46 accounting purposes and **MUST** be correct. *Note you can only get paid for
  47 stuff done **after the nlnet grant is approved** (before the MOU is signed)*
  48
  49 If a developer ever needs to check which bugs are assigned to them, go to the
  50 Libre-SOC bug tracker
  51 [advanced search page](https://bugs.libre-soc.org/query.cgi?format=advanced),
  52 and in the "Search by People" section, check "Bug Assignee" and "contains"
  53 and write your nickname (i.e. andrey etc.).