Add "Contributing" section
This commit is contained in:
Родитель
3dab27c235
Коммит
e471abfa0f
30
README.md
30
README.md
|
@ -1,19 +1,6 @@
|
|||
# overworld ![Build status badge](https://github.com/riknoll/overworld/workflows/MakeCode/badge.svg)
|
||||
# Tilemaps ![Build status badge](https://github.com/riknoll/overworld/workflows/MakeCode/badge.svg)
|
||||
|
||||
This extension contains advanced APIs for working with tilemaps in blocks. The APIS are
|
||||
divided into two categories:
|
||||
|
||||
1. **Tilemap** - Blocks that can be used with any tilemap in Microsoft MakeCode Arcade
|
||||
1. **Overworld** - Blocks that can be used to create multiple tilemaps and transition between them
|
||||
|
||||
Overworld is great for creating worlds in MakeCode Arcade composed of multiple
|
||||
tilemaps. Here are some good use cases:
|
||||
|
||||
1. Games with multiple levels
|
||||
1. Games with multiple settings linked by doorways
|
||||
1. Games with locations connected by an overworld
|
||||
1. Top-down games where the player moves between multiple connected "screens"
|
||||
1. Procedurally generated tilemap games
|
||||
This extension contains advanced APIs for working with tilemaps in blocks.
|
||||
|
||||
## Create a project with this extension
|
||||
|
||||
|
@ -37,3 +24,16 @@ To edit this repository in Microsoft MakeCode.
|
|||
* for PXT/arcade
|
||||
(The metadata above is needed for package search.)
|
||||
|
||||
# Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
||||
|
||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
||||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
|
Загрузка…
Ссылка в новой задаче