Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

69 lines (43 loc) · 3.31 KB
Raw

Contributing

Folder organization & conventions

  • Courses are placed in their own directory, under a top-level directory courses.
  • Longer courses can be divided into modules and units. A module is a collection of units.
  • Units shall be placed in their own directory, with a single README.md file as the content.
  • Diagrams or illustrations shall be nested in units' directories under assets.
  • Modules and units must be numbered, starting from 1. They shall also have a title.
  • Prefer underscores over spaces in folders and filenames.
  • Modules and units shall be named as {number}-{title}. e.g. 1-blockchain_overview

Feedback

Feedback is welcome, whether it be a suggestion, contributing an improved infographic, or maybe some questions that you have. It helps in improving the course(s) over time and these are the best kind of contributions to start with.

Do not hesitate to add thumbs up 👍 on suggestions you support to show your interest.

Any updates, typo fixes, or expansion of the course content is more than welcome. Note however that courses are generally targeted at a specific audience, generally beginner, intermediate, advanced. We often cover the same topic in more detail in later course(s).

Pull requests are welcome, but we do recommend you open an issue to bring any idea to discussion first! Especially if the pull request will end up very large, any significant changes should be discussed up front with the maintainers. This avoids awkward situations where someone puts in a bunch of work to ultimately have the pull request closed due to a potential variety of unforeseen reasons.

The content is in 'markdown' format, a cheatsheet is available here.

License and attribution

All contributions must be properly licensed and attributed. If you are contributing your own original work, then you are offering it under a Mozilla Public License 2.0 . You are responsible for adding your own name or pseudonym in the Github Contributors section, as attribution for your contribution.

If you are sourcing a contribution from somewhere else, it must carry a compatible license. You need to indicate the original source and original license, by including an comment above your contribution in this suggested format:

Source: https://example.com/originaltext
License: MPL-2.0 license
Added by: @joebloggs

Changelog

We keep changelogs for each course. Please add an entry into their corresponding CHANGELOG.md when submitting changes. This let's us keep track of unreleased changes for future course iterations. Each changelog must abide by the following format:

## {version} - {YYYY-MM-DD}

### Added

- some new thing

### Changed

- fixed or updated something

### Removed

- something is gone now

Tip

When not-yet-release, use unreleased as a version and date.

Discussions

💡 Do you have an Idea to propose, or a question to ask? ❓
...Feel free to Start a discussion

Thanks

As Cardano constantly evolves, feedback and contributions are welcome, and indeed needed. We are very grateful for the support of the entire Cardano community. Thank you!

Contact us: [email protected]