Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Community Recipes #164

Merged
merged 10 commits into from
Jul 19, 2024
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Open Source License Notice for Contributors
cdanwards marked this conversation as resolved.
Show resolved Hide resolved

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!
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.
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/
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 0 additions & 2 deletions docs/archive/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 8 additions & 0 deletions docs/communityRecipes/index.md
Original file line number Diff line number Diff line change
@@ -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).
10 changes: 8 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
cdanwards marked this conversation as resolved.
Show resolved Hide resolved
collapsed: true,
items: [{ type: "autogenerated", dirName: "communityRecipes" }],
},
{
type: "category",
label: "Archive",
Expand Down
Loading