diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..cd424e92 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +# Open Source License Notice for Contributors + +If you are contributing a recipe to this repository, you agree to license your contribution under the terms of the [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license. + +If you have any questions, please reference the [CONTRIBUTING.md](../CONTRIBUTING.md) or [LICENSE.md](../LICENSE.md) file for more information. + +Thank you for your contribution! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 993be492..e63d9e93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,8 @@ $ yarn start This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +For contributions from members of the Ignite community, please nest the recipe in the `docs/communityRecipes` directory. This will allow us to easily identify and promote community contributions. + ### Recipe Template When creating a recipe there are a few needed elements (front-matter) for Docusaurus: @@ -81,4 +83,10 @@ export default ExampleCodeBlock = () => ( To allow customization of pre-built theme components, Docusaurus has a feature called [swizzling](https://docusaurus.io/docs/swizzling), which either allows creating a wrapper around the existing component, or creating a copy of it that can be modified. -It's totally fine to swizzle components, even "unsafe" ones, but take care to minimize changes so that it's easy to upgrade components to their latest versions later on. \ No newline at end of file +It's totally fine to swizzle components, even "unsafe" ones, but take care to minimize changes so that it's easy to upgrade components to their latest versions later on. + +## License + +This project is licensed under the MIT - see the [LICENSE](./LICENSE.md) file for details. + +Any contributions you make to this project will be made under the Creative Commons Attribution 4.0 International (CC BY 4.0) license: https://creativecommons.org/licenses/by/4.0/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..e18a4378 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2024 Infinite Red, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 8271e11f..23a7436c 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,7 @@ > The Ignite Cookbook isn’t just a random group of code snippets. It’s a curated collection of usable code samples that the Infinite Red team’s used in their own React Native projects. Having worked with some of the biggest clients in the tech industry, we know a thing or two about keeping our code to a high standard. You can code confidently! ### [Accelerate your development and dive into the Ignite Cookbook for React Native today!](https://ignitecookbook.com) + +--- + +Contributions are welcome! Read the [Contributing Guide](./CONTRIBUTING.md) for more information. diff --git a/docs/archive/index.md b/docs/archive/index.md index 77782759..d1e32794 100644 --- a/docs/archive/index.md +++ b/docs/archive/index.md @@ -3,8 +3,6 @@ sidebar_position: 1 title: Overview tags: - Archive -last_update: - author: Frank Calise --- These recipes apply to older versions of Ignite for those with existing projects who may not be in sync with the latest dependencies. diff --git a/docs/recipes/CustomVectorIcons.md b/docs/communityRecipes/CustomVectorIcons.md similarity index 100% rename from docs/recipes/CustomVectorIcons.md rename to docs/communityRecipes/CustomVectorIcons.md diff --git a/docs/communityRecipes/index.md b/docs/communityRecipes/index.md new file mode 100644 index 00000000..0c101ada --- /dev/null +++ b/docs/communityRecipes/index.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 1 +title: Overview +tags: + - Community +--- + +These recipes in this section are contributed by our amazing community! If you have a recipe you'd like to share, please submit a PR to the [Ignite Cookbook Github Repo](http://github.com/infinitered/ignite-cookbook). diff --git a/sidebars.js b/sidebars.js index 060b932e..b8459211 100644 --- a/sidebars.js +++ b/sidebars.js @@ -22,10 +22,16 @@ const sidebars = { }, { type: "category", - label: "Recipes", - collapsed: false, + label: "Infinite Red Recipes", + collapsed: true, items: [{ type: "autogenerated", dirName: "recipes" }], }, + { + type: "category", + label: "Community Recipes", + collapsed: true, + items: [{ type: "autogenerated", dirName: "communityRecipes" }], + }, { type: "category", label: "Archive",