Developer Documentation

Home for general best practices & developer workflow documentation. Any and all additions to this documentation should come in the form of PR‘s. If you have a thought for a doc but you‘re unsure or have questions, please open an issue.

Sections

1. Agile methodology for developers: Documentation on the agile process
2. Git: Git usage and practices
3. Standardization: Standards for software development
4. Style Guide: Style guide for coding, documentation, etc.

Contributing Guidelines

• Open a pull request with the new doc.
• Always use markdown.
• Choose an existing directory to place the new doc in or create a new “section.”

• If the doc has relevant assets (images, pdfs, etc.) please create an assets dir named <section>/<doc-name>-assets. For instance:

  git/
  ├── branching-assets/
  │   └── img.png
  └── branching.md
  

• If you think the doc is more of a one-off and doesn‘t really fit into a broad enough section, then put it in /docs.
• Directories should always be totally lowercase with dashes separating words.
• Document filenames should always be totally lowercase with dashes separating words, i.e. name-with-dashes.md.

Disclaimer: this documentation was based on Developer Documentation of EY Blockchain Group. Some files were purged, others updated in order to reflect the actual state of software engineering regarding the Latam South region.