Code Monkey home page Code Monkey logo

curriculum's Introduction

The project is in development now and is open for contributions

Design

Figma code-editor

How to run

  1. npm i
  2. npm run dev

๐Ÿ™Œ Contributing to Curriculum

From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you're planning to implement a new feature or change the API please create an issue first. This way we can ensure your work is not in vain.

Where to add content and how it works?

There is a website readme file which lists out how the curriculum is structured and which files need to be updated for adding content

Steps for contributing

  1. Create or pick an issue from the issues
  2. If adding a new feature create an issue with lots of details to support. You can even start a discussion here to gain upvotes or ask for improvising the idea.
  3. For a member create a branch and send PR
  4. The contributions guide is generally forking and pull request for outside collaborators

Happy hacking

Commit mesage

  • Specify the type of commit:
    • feat: The new feature you're adding to a particular application
    • fix: A bug fix
    • style: Feature and updates related to styling
    • refactor: Refactoring a specific section of the codebase
    • test: Everything related to testing
    • docs: Everything related to documentation
    • chore: Regular code maintenance.[ You can also use emojis to represent commit types]
  • Separate the subject from the body with a blank line
  • Your commit message should not contain any whitespace errors
  • Remove unnecessary punctuation marks
  • Do not end the subject line with a period
  • Capitalize the subject line and each paragraph
  • Use the imperative mood in the subject line
  • Use the body to explain what changes you have made and why you made them.
  • Do not assume the reviewer understands what the original problem was, ensure you add it.
  • Do not think your code is self-explanatory
type: title

Why this is necessary, how it is done

fixes issue #number

for example

Feat: Create new post

New post can be created using the + button. Api /post/create is used. The store integration is with react-redux. Modal uses ABCD package.

fixes issue #223

curriculum's People

Contributors

akhilalekha avatar safaldas avatar that-coder avatar sangeeths1997 avatar felix-aj avatar thealpha93 avatar iamaseem avatar gwrisnkr avatar athulraj2002 avatar ashwinchandran13 avatar misuvi avatar sijokuriakose avatar dudelogic avatar jayakrishnanjr2410 avatar

Watchers

James Cloos avatar  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.