safaldas / curriculum

Free curriculum platform - for devs who like to learn web development!

The project is in development now and is open for contributions

Design

Figma

How to run

1. yarn install
2. yarn 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

Switch to development branch before start working as it has the latest code

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