You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.5 KiB

  1. # Road Map #
  2. This document is the KiCad Developer's road map document. It is a living
  3. document that should be maintained as the project progresses. The goal of
  4. this document is to provide an overview for developers of where the project
  5. is headed beyond the current development cycle road map (currently
  6. [version 6](./v6_road_map.html) to prevent resource conflicts and endless
  7. rehashing of previously discussed topics. It is broken into sections for
  8. each major component of the KiCad source code and documentation. It defines
  9. tasks that developers an use to contribute to the project and provides updated
  10. status information. Tasks should define clear objectives and avoid vague
  11. generalizations so that a new developer can complete the task. It is not a
  12. place for developers to add their own personal wish list It should only be
  13. updated with approval of the project manager after discussion with the lead
  14. developers.
  15. Each entry in the road map is made up of four sections. The goal should
  16. be a brief description of the what the road map entry will accomplish. The
  17. task section should be a list of deliverable items that are specific enough
  18. hat they can be documented as completed. The dependencies sections is a list
  19. of requirements that must be completed before work can begin on any of the
  20. tasks. The status section should include a list of completed tasks or marked
  21. as complete as when the goal is met.
  22. [TOC]
  23. # Project # {#project}
  24. This section defines the tasks for the project related goals that are not
  25. related to coding or documentation. It is a catch all for issues such as
  26. developer and user relations, dissemination of information on websites,
  27. policies, etc.
  28. # General # {#general}
  29. This section defines the tasks that affect all or most of KiCad or do not
  30. fit under as specific part of the code such as the board editor or the
  31. schematic editor.
  32. # Build Tools # {#build_tools}
  33. This section covers build tools for both the KiCad source as well as the
  34. custom dependency builds required to build KiCad.
  35. # Common Library # {#common_lib}
  36. This section covers the source code shared between all of the KiCad
  37. applications
  38. # KiCad: Application Launcher # {#kicad}
  39. This section applies to the source code for the KiCad application launcher.
  40. # Eeschema: Schematic Editor # {#eeschema}
  41. This section applies to the source code for the Eeschema schematic editor.
  42. # CvPcb: Footprint Association Tool # {#cvpcb}
  43. This section covers the source code of the footprint assignment tool CvPcb.
  44. # Pcbnew: Circuit Board Editor # {#pcbnew}
  45. This section covers the source code of the board editing application Pcbnew.
  46. # GerbView: Gerber File Viewer # {#gerbview}
  47. This section covers the source code for the GerbView gerber file viewer.
  48. # Documentation # {#documentation}
  49. This section defines the tasks for both the user and developer documentation.
  50. ## Maintenance ## {#doc_maintenance}
  51. **Task:**
  52. - Keep screen shots current with the source changes.
  53. **Dependencies:**
  54. - None.
  55. **Status:**
  56. - No progress.
  57. # Unit Testing # {#unittest}
  58. **Goal:**
  59. Improve the quality of KiCad and ensure changes do no break existing
  60. capabilities.
  61. **Task:**
  62. - Explore the possibility of including a C++ unit test framework in addition
  63. to the existing Python framework.
  64. - Create robust enough test coverage to determine if code changes break any
  65. core functionality.
  66. **Dependencies:**
  67. - Completion of the initial release of this document.
  68. **Status:**
  69. - In progress.
  70. [kicad-website]:http://kicad-pcb.org/
  71. [kicad-docs]:http://ci.kicad-pcb.org/job/kicad-doxygen/ws/Documentation/doxygen/html/index.html