Dear members of the Miracle Factory community, this repo guide is a quick reference to help you get started with building your repository under Miracle Factory.
The previous rules of naming your repository have been removed. Now, there are no restriction on how you name your repository, but please use good names and semantically make sence ones.
The repository description should be a short summary of the repository's purpose.
You should have a README.md file in your repository. Describe the repository in detail.
- Project Repos: no restrictions on license type.
- Research Repos: the license type must be one of the following:
- Apache-2.0
- GPL-3.0
- CC Licenses
This file is located in the .github repository of Miracle Factory. Check if your repository has auto-included the CONTRIBUTING.md file(this file should be visible in the "contribute" page of your repo, not in the root directory of your repo). If it is not visible in the "contribute" page, add it to the root directory of your repository.
This file is located in the .github repository of Miracle Factory. Check if your repository has auto-included the CODE_OF_CONDUCT.md file(this file should be visible in the repo description bar). If it is not visible, add it to the root directory of your repository.
