Skip to content

Contributing Use cases

Peter Klein edited this page Nov 1, 2018 · 2 revisions

Example workflow based on https://github.com/json-editor/json-editor/issues/180#issuecomment-433689965

  • One or more reported issues lead to a wiki page, that discusses the design process for a new major release that covers the issues or improvements.
  • The documentation is created before the implementation actually happens.
  • After the design process is agreed on assignment to specific work packages are documented in the wiki, ...
  • New developers that want to contribute to the new release can work through the Wiki document and know where some contributions are missing or contribute directly to the wiki because they identified already some design problems, that may be an obstacle for applications of the library in the future
  • After a major release is finalized the documentation for the release is ready.