Git Product home page Git Product logo

nala's Introduction

Nala

Nala is a open source repository for gathering and experimenting with food recipes

Purpose

  • Create, track and share recipes easily
  • Easily experiment with recipes, tracking results of variations and versioning them
  • Allow others to contribute and propose changes to your recipe (there's always room for improvement ๐Ÿ˜›)

Structure

All recipes need to use the markdown format, and need to follow the following structure (proposals to change the structure are welcome)

# Recipe Title
## Description
## Ingredients
## Steps
## Variations
## Additional infromation

If your recipe has multiple parts, use sub-recipes below the description section:

# Recipe Title
## Description
## Sub-recipe 1
### Description
### Ingredients
### Steps
...

## Sub-recipe 2
### Description
### Ingredients
### Steps
...

Contribution

Branches

  • main - all finalized recipes go into this branch
  • develop - work-in-progress/experimental recipes go here

For experimentation, creating PRs, e.t.c, fork the repo and create PRs

Pull Requests

If you're confident about your recipe to go into develop/master, create a PR from your branch to the destination branch. PRs to main will be reviewed thoroughly before being merged.

Planned Improvements

  • Include a github.io page with a markdown editor to make it easier for people to contribute
  • Add pre-merge checks

If you have any other recommendations/feature requests, feel free to contribute - open a PR, or create an issue

nala's People

Contributors

ghanashyamvtatti avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.