Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 3.8 KB

README.md

File metadata and controls

60 lines (42 loc) · 3.8 KB
Raw

🌻 opensource-template

Template for creating new open source repositories that follow the Embark open source guidelines

Embark Embark Crates.io Docs Git Docs dependency status Build status

TEMPLATE INSTRUCTIONS

  1. Create a new repository under EmbarkStudios using this template.
  2. Title: Change the first line of this README to the name of your project, and replace the sunflower with an emoji that represents your project. 🚨 Your emoji selection is critical.
  3. Badges: In the badges section above, change the repo name in each URL. If you are creating something other than a Rust crate, remove the crates.io and docs badges (and feel free to add more appropriate ones for your language).
  4. CI: In ./github/workflows/ rename rust-ci.yml (or the appropriate config for your language) to ci.yml. And go over it and adapt it to work for your project
    • If you aren't using or customized the CI workflow, also see the TODO in .mergify.yml
    • If you want to use the automatic rustdoc publishing to github pages for git main, see rustdoc-pages.yml
  5. Issue & PR Templates: Review the files in .github/ISSUE_TEMPLATE and .github/pull_request_template. Adapt them to suit your needs, removing or re-wording any sections that don't make sense for your use case.
  6. CHANGELOG.md: Change the $REPO_NAME in the links at the bottom to the name of the repository, and replace the example template lines with the actual notes for the repository/crate.
  7. release.toml: in ./release.toml change the $REPO_NAME to the name of the repository
  8. Cleanup: Remove this section of the README and any unused files (such as configs for other languages) from the repo.

Contributing

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

at your option.

For clarity, "your" refers to Embark or any other licensee/user of the contribution.