Skip to content

Commit

Permalink
docs: use latest md template
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoRCD committed Mar 30, 2024
1 parent 7c2f09a commit e958d88
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 18 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,31 +34,37 @@ COMMANDS
Use shelve <command> --help for more information about a command.
```

<!-- automd:fetch url="gh:hugorcd/markdown/main/src/local_development.md" -->

### Local development

- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `bun install`
- Start development server using `bun dev`
- Open [http://localhost:3000](http://localhost:3000) in your browser

<!-- /automd -->

<!-- automd:fetch url="gh:hugorcd/markdown/main/src/contributions.md" -->

## Contributing
To start contributing, you can follow these steps:

1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch with a descriptive name `add-feature` or `fix-issue`.
4. Make changes following the local development steps [above](#local-development).
3. Create a branch using conventional commits and the issue number as the branch name. For example, `feat/123` or `fix/456`.
4. Make changes following the local development steps.
5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
6. Run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md).
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
6. If your changes affect the code, run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !

<!-- /automd -->

<!-- automd:contributors license=MIT author="HugoRCD" -->

<!-- ⚠️ (contributors) `github` is required! -->
Expand Down
5 changes: 2 additions & 3 deletions apps/app/server/app/projectService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export async function createProject(project: CreateProjectInput, userId: number)
const projectAlreadyExists = await isProjectAlreadyExists(project.name, userId)
if (projectAlreadyExists) throw new Error('Project already exists')
if (project.team) {
return prisma.project.create({
return await prisma.project.create({
data: {
...project,
ownerId: userId,
Expand All @@ -23,7 +23,7 @@ export async function createProject(project: CreateProjectInput, userId: number)
}
})
}
return prisma.project.create({
return await prisma.project.create({
data: {
...project,
ownerId: userId,
Expand All @@ -34,7 +34,6 @@ export async function createProject(project: CreateProjectInput, userId: number)
}
}
})

}

export async function updateProject(project: ProjectUpdateInput, projectId: number, userId: number) {
Expand Down
16 changes: 11 additions & 5 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,31 +38,37 @@ COMMANDS
Use shelve <command> --help for more information about a command.
```

<!-- automd:fetch url="gh:hugorcd/markdown/main/src/local_development.md" -->

### Local development

- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `bun install`
- Start development server using `bun dev`
- Open [http://localhost:3000](http://localhost:3000) in your browser

<!-- /automd -->

<!-- automd:fetch url="gh:hugorcd/markdown/main/src/contributions.md" -->

## Contributing
To start contributing, you can follow these steps:

1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, `feat/123` or `fix/456`.
4. Make changes following the local development steps [above](#local-development).
4. Make changes following the local development steps.
5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
6. Run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md).
6. If your changes affect the code, run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !

<!-- /automd -->

<!-- automd:contributors license=Apache author="HugoRCD" -->

Published under the [APACHE](https://github.com/HugoRCD/shelve/blob/main/LICENSE) license.
Expand Down
1 change: 1 addition & 0 deletions apps/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
},
"homepage": "https://shelve.hrcd.fr",
"scripts": {
"automd": "automd",
"build": "automd && unbuild",
"start": "node ./dist/index.mjs",
"typecheck": "tsc --noEmit",
Expand Down
2 changes: 1 addition & 1 deletion packages/shelve-types/src/Project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ export type Project = {
};

export type CreateProjectInput = {
id?: number;
name: string;
description: string;
avatar: string;
repository: string;
projectManager: string;
homepage: string;
users: User[];
team?: Team;
};

Expand Down

0 comments on commit e958d88

Please sign in to comment.