Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
brunobuddy committed Jan 9, 2025
1 parent 9cf0ea7 commit 3d5ddcf
Show file tree
Hide file tree
Showing 17 changed files with 55 additions and 70 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: Code coverage
on:
pull_request:
branches: [master]
push:
branches: [master]

jobs:
run:
Expand Down
48 changes: 17 additions & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,55 +23,41 @@ Before coding it is important to understand where the functionality you want to

Manifest is a set of several packages and [repositories](https://github.com/orgs/mnfst/repositories) built with open source software, using TypeScript as the main language.

| Name | Description | Stack | Repo | Package |
| -------------- | ------------------------------------------ | -------------------------- | --------------------------------------------- | ---------------------------------------------------------- |
| Manifest | Manifest core | NestJS / Express / TypeORM | [manifest](https://github.com/mnfst/manifest) | [manifest](https://www.npmjs.com/package/manifest) |
| Manifest Admin | Official Admin Panel | Angular | [manifest](https://github.com/mnfst/manifest) | - |
| Add Manifest | NPX install script | OCLIF | [manifest](https://github.com/mnfst/manifest) | [add-manifest](https://www.npmjs.com/package/add-manifest) |
| JS SDK | Client JavaScript SDK | TypeScript | [manifest](https://github.com/mnfst/manifest) | [@mnfst/sdk](https://www.npmjs.com/package/@mnfst/sdk) |
| Website | Official website: https://manifest.build | NextJS | [website](https://github.com/mnfst/website) | - |
| Docs | Documentation: https://manifest.build/docs | Markdown / Docusaurus | [docs](https://github.com/mnfst/docs) | - |
| Name | Description | Stack | Repo | Package |
| -------------- | --------------------------------------------------------------- | ---------------- | --------------------------------------------- | ---------------------------------------------------------- |
| Manifest | Manifest core | NestJS / TypeORM | [manifest](https://github.com/mnfst/manifest) | [manifest](https://www.npmjs.com/package/manifest) |
| Manifest Admin | Official Admin Panel | Angular | [manifest](https://github.com/mnfst/manifest) | - |
| Add Manifest | NPX install script | OCLIF | [manifest](https://github.com/mnfst/manifest) | [add-manifest](https://www.npmjs.com/package/add-manifest) |
| JSON Schema | Manifest JSON SCHEMA: https://schema.manifest.build/schema.json | JSON | [manifest](https://github.com/mnfst/manifest) | - |
| Types | Manifest Types library | TypeScript | [manifest](https://github.com/mnfst/manifest) | - |
| Helpers | Manifest Helpers library | TypeScript | [manifest](https://github.com/mnfst/manifest) | - |
| JS SDK | Client JavaScript SDK | TypeScript | [manifest](https://github.com/mnfst/manifest) | [@mnfst/sdk](https://www.npmjs.com/package/@mnfst/sdk) |
| Website | Official website: https://manifest.build | NextJS | [website](https://github.com/mnfst/website) | - |
| Docs | Documentation: https://manifest.build/docs | Docusaurus | [docs](https://github.com/mnfst/docs) | - |

## Development workflow and guidelines

### Prerequisites

- You are familiar with Git (issues and PR)
- You are familiar with Git (issues and PR) and **Github flow**
- You have read the [docs](https://manifest.build/docs)
- You have looked at the [Code of Conduct](https://github.com/mnfst/manifest/blob/master/CODE_OF_CONDUCT.md) and [MIT License](https://github.com/mnfst/manifest/blob/master/LICENSE)

### Before you start

- Manifest is built on the concept of simplicity, contributions should go in that direction
- Each PR code quality is checked with CodeFactor
- Each PR code quality is checked with [CodeFactor](https://www.codefactor.io/) for syntax, [CodeCov](https://codecov.com/) for testing coverage and [Changesets](https://github.com/changesets/changesets) for version numbers and changelogs
- Commit labels should be made using the [Conventional Commits convention](https://www.conventionalcommits.org/en/v1.0.0/)
- 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](https://github.com/mnfst/manifest/issues) for what you will be working on. If not, [create one](https://github.com/mnfst/manifest/issues/new) 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)
2. When ready, **create a branch** for the issue your are fixing from the Github issue "Development" paragraph in the sidebar
3. Make your changes
4. Open a [Pull Request from your fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-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.

### Tags

Each merge on the `master` branch that updates a **package** should be tagged by the name of the package, "@" and the version number. Ex: `[email protected]`
4. Run `npx changeset` and add the [changeset](https://github.com/changesets/changesets) for your work
5. Open a [Pull Request from your fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) from your branch to the `master` branch
6. The core team will review it soon, ask for feedback, and eventually merge it

### Getting started

Expand Down
8 changes: 4 additions & 4 deletions examples/main-demo/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/main-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/auth/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/auth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/collections/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/collections/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/relations/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/relations/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/singles/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/singles/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/storage/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/storage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
8 changes: 4 additions & 4 deletions examples/website/validation/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/website/validation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"manifest:seed": "node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js"
},
"dependencies": {
"manifest": "^4.3.0"
"manifest": "^4.3.1"
}
}
5 changes: 3 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3d5ddcf

Please sign in to comment.