Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

75 lines (48 loc) · 4.98 KB

Contributing to Manifest

Thank you for taking the time to contribute to Manifest! 🫶 🎉

Manifest aims to simplify backend development. We want to make backends simple and fun, allowing more people to create and share their own tools.

Manifest is an Open Source project hosted under the Manifest organization on GitHub

How can I contribute?

There are several ways to contribute to Manifest other than developing:

Otherwise, you also can offer your help by talking to a team member on our Discord 🤗.

Packages and repositories

Before coding it is important to understand where the functionality you want to change is located.

Manifest is a set of several packages and repositories built with open source software, using TypeScript as the main language.

Name Description Stack Repo Package
Manifest Manifest core NestJS / Express / TypeORM manifest manifest
Manifest Admin Official Admin Panel Angular manifest @mnfst/admin
Manifest Types Utility types TypeScript manifest @mnfst/types
Add Manifest NPX install script OCLIF manifest add-manifest
JS SDK JavaScript SDK TypeScript js-sdk @mnfst/sdk
Website Official website: https://manifest.build NextJS website -
Docs Documentation: https://manifest.build/docs Markdown / Docusaurus docs -

Development workflow and guidelines

Prerequisites

Before you start

  • Manifest is built on the concept of simplicity, contributions should go in that direction
  • Each PR is linted with Prettier, and code quality is checked with CodeFactor
  • Commit labels should be made using the Conventional Commits convention
  • Please create only one thing per pull request as it is easier to validate and merge

Workflow

  1. Make sure that there is an existing issue for what you will be working on. If not, create one as this ensures that others can contribute with thoughts or suggest alternatives
  2. When ready, fork the correct repository and branch out from the develop branch (or master for a hotfix)
  3. Make your changes
  4. Open a Pull Request from your fork
  5. The core team will review it soon, ask for feedback, and eventually merge it

Branches

There are 2 main branches:

  • master: production version
  • develop: development branch

When contributing, please follow this branch naming convention:

  • feature/x branches add new features and the PR should be done to the develop branch
  • hotfix/x branches create a hotfix and the PR should be done to the master branch

This rule applies to all repositories.

Happy coding! 🤗