Home

This wiki is for discussion of development and engineering issues.

What's here is, by definition, a work in progress. This doesn't mean it is not detailed or structured, just that there's no consensus implied about it.

Conventions

• Wiki page titles should be as clear and readable as possible.

  • Capitalize significant words
  • Use spaces to separate words.

• Group related pages by a common prefix to make them easy to see in the page index. e.g.

  Python: Best Practice
  Python: Style Guide
  Python: Toolchain
  Go: Best Practice
  ...
  

• Prefer longer organized pages to collect many related items. For instance there's a lot involved in any language tool chain, but it's better to have one long page with lots of sections than lots of pages. (The reason is that GitHub wikis don't have subpages and a long list becomes hard to manage.)

Workflow

A proposed workflow for this repository.

• Use the Wiki for notes and brainstorming.
• Use Discussions for all discussion in common. Discussions should use the wiki for notes that are still in the brainstorming phase.
  • Design problems
  • Library and toolchain choices
• Use Issues to make formal proposals based on consensus in Discussions.
  • Policies, recommendation or best practice
  • Toolchain choices
  • Useful scripts and conmfigurations
  • etc.
• Use PRs to write up and review formal proposals.
• Use Projects to:
  • Track proposals and other tasks that warrant issues.
  • Track milestones that are bigger than one project or affect all projects.
• Use carefully chosen labels to organize of all of the above.
  • Status / task lifecycle
  • Priorities
  • ElectOS subsystems