LearnNewsExamplesServices
Frontmatter
titleFix #661: Add documentation for repository structure
authorticklepoke
stateMerged
createdAtJun 7, 2020, 4:33 AM
updatedAtJun 8, 2020, 5:36 PM
closedAtJun 8, 2020, 5:35 PM
mergedAtJun 8, 2020, 5:35 PM
branchesdevdocumentation
urlhttps://github.com/neomjs/neo/pull/696
Merged
ticklepoke
ticklepoke commented on Jun 7, 2020, 4:33 AM

Please make sure to read the Contributing Guidelines:

https://github.com/neomjs/neo/blob/dev/CONTRIBUTING.md

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: Documentation

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information: This PR includes documentation for the codebase overview, to introduce incoming devs to how the repository is structured. The CODEBASE_OVERVIEW.md file is referenced in point 3.6 of the CONTRIBUTING.md file.

tobiu
tobiu commented on Jun 8, 2020, 5:36 PM

needed a short break, merged now :) Thx!