Skip to content

Conversation

hasib-devs
Copy link
Owner

This pull request includes several updates to improve the project configuration, documentation, and testing setup. The most important changes include the addition of new GitHub templates, updates to the package.json scripts and dependencies, and the introduction of a CodeQL analysis workflow.

GitHub Templates and Configuration:

Documentation:

  • docs/ARCHITECTURE.md: Added a comprehensive architecture document detailing the design principles, directory structure, components, and contributing guidelines for the project.
  • docs/CONTRIBUTING.md: Created a contributing guide with steps for forking the repository, creating branches, committing changes, and submitting pull requests.

Code Quality and Testing:

  • .github/workflows/codeql.yml: Introduced a CodeQL analysis workflow to analyze code for vulnerabilities and ensure code quality.
  • eslint.config.mjs: Configured ESLint with TypeScript support and added rules for code consistency and best practices.
  • tests/controllers/user.test.ts: Added a basic test case for the UserController to ensure the registration of the GET /users route.

Package Configuration:

  • package.json: Updated scripts to include build, development, testing, and linting commands. Added new peer dependencies and dev dependencies for ESLint and TypeScript. [1] [2]
  • .npmrc: Removed the scoped registry configuration for @hasib-devs.

@hasib-devs hasib-devs self-assigned this Mar 1, 2025
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@hasib-devs hasib-devs merged commit 9e00cf1 into main Mar 1, 2025
2 checks passed
hasib-devs added a commit that referenced this pull request Mar 2, 2025
* feat: Added  common configurations (#2)

* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* chore(deps): bump @types/node from 22.13.7 to 22.13.8

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.13.7 to 22.13.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Hasibur Rahman <hasib.webdev@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
hasib-devs added a commit that referenced this pull request Mar 2, 2025
* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* Update workflows to trigger on push to develop and main, add test workflow, and enhance release process

* Update Dependabot configuration to change commit message prefix for dependency updates

* Update Dependabot configuration to set target branch to develop

* feat: Update workflows to trigger on pull requests and add CodeQL configuration

* feat: Add security-events permission to CodeQL workflow

* chore: Remove pull request triggers from CodeQL and test workflows

* chore: Upgrade CodeQL action versions to v3 in workflow configuration

* feat: Rename jobs in workflows for clarity and consistency

* feat: Update CodeQL configuration and add caching for improved performance

* chore(deps): bump @types/node from 22.13.7 to 22.13.8 (#3)

* feat: Added  common configurations (#2)

* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* chore(deps): bump @types/node from 22.13.7 to 22.13.8

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.13.7 to 22.13.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Hasibur Rahman <hasib.webdev@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: Add reflect-metadata as a peer dependency in package.json

* chore: Update workflows to only trigger on main branch

* feat: Add GitHub release step to workflow and update installation instructions for pnpm

* feat: Update semantic configuration and add changelog workflow

* ci(release): semantic release

Add semantic-release for automated versioning and create release workflow

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
hasib-devs added a commit that referenced this pull request Mar 2, 2025
* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* Update workflows to trigger on push to develop and main, add test workflow, and enhance release process

* Update Dependabot configuration to change commit message prefix for dependency updates

* Update Dependabot configuration to set target branch to develop

* feat: Update workflows to trigger on pull requests and add CodeQL configuration

* feat: Add security-events permission to CodeQL workflow

* chore: Remove pull request triggers from CodeQL and test workflows

* chore: Upgrade CodeQL action versions to v3 in workflow configuration

* feat: Rename jobs in workflows for clarity and consistency

* feat: Update CodeQL configuration and add caching for improved performance

* chore(deps): bump @types/node from 22.13.7 to 22.13.8 (#3)

* feat: Added  common configurations (#2)

* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* chore(deps): bump @types/node from 22.13.7 to 22.13.8

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.13.7 to 22.13.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Hasibur Rahman <hasib.webdev@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: Add reflect-metadata as a peer dependency in package.json

* chore: Update workflows to only trigger on main branch

* feat: Add GitHub release step to workflow and update installation instructions for pnpm

* feat: Update semantic configuration and add changelog workflow

* ci(release): semantic release

Add semantic-release for automated versioning and create release workflow

* chore: remove GitHub release workflow file

* chore: remove changelog workflow file

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
hasib-devs added a commit that referenced this pull request Mar 2, 2025
* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* Update workflows to trigger on push to develop and main, add test workflow, and enhance release process

* Update Dependabot configuration to change commit message prefix for dependency updates

* Update Dependabot configuration to set target branch to develop

* feat: Update workflows to trigger on pull requests and add CodeQL configuration

* feat: Add security-events permission to CodeQL workflow

* chore: Remove pull request triggers from CodeQL and test workflows

* chore: Upgrade CodeQL action versions to v3 in workflow configuration

* feat: Rename jobs in workflows for clarity and consistency

* feat: Update CodeQL configuration and add caching for improved performance

* chore(deps): bump @types/node from 22.13.7 to 22.13.8 (#3)

* feat: Added  common configurations (#2)

* Refactor npm configuration and add issue/bug report templates

* Add tests for UserController and update Dependabot configuration

* Add CodeQL workflow for automated code analysis

* Update CodeQL workflow to trigger only on pull requests

* chore(deps): bump @types/node from 22.13.7 to 22.13.8

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.13.7 to 22.13.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Hasibur Rahman <hasib.webdev@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: Add reflect-metadata as a peer dependency in package.json

* chore: Update workflows to only trigger on main branch

* feat: Add GitHub release step to workflow and update installation instructions for pnpm

* feat: Update semantic configuration and add changelog workflow

* ci(release): semantic release

Add semantic-release for automated versioning and create release workflow

* chore: remove GitHub release workflow file

* chore: remove changelog workflow file

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@hasib-devs
Copy link
Owner Author

🎉 This PR is included in version 0.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant