feat: Overhaul repository structure and add professional project setup#7
Closed
fderuiter wants to merge 1 commit intofeature/add-documentationfrom
Closed
feat: Overhaul repository structure and add professional project setup#7fderuiter wants to merge 1 commit intofeature/add-documentationfrom
fderuiter wants to merge 1 commit intofeature/add-documentationfrom
Conversation
This commit performs a comprehensive overhaul of the repository to establish a robust foundation for future development, maintainability, and team collaboration. The following changes were made: - Standardized the directory structure by creating `/src`, `/docs`, `/tests`, and `/scripts` directories and moving the relevant files into them. - Enhanced core documentation by overhauling the `README.md`, creating a `CONTRIBUTING.md`, and adding GitHub issue and pull request templates. - Enforced code quality and consistency by adding `.editorconfig`, `.prettierrc`, `.prettierignore`, and `.spectral.yaml`. Added Prettier and formatted the codebase. - Streamlined environment and dependency management by creating a comprehensive `.gitignore` and updating `package.json` with the necessary dev dependencies. - Implemented a CI/CD foundation by adding `lint`, `format`, and `test` scripts to `package.json` and creating a GitHub Actions CI workflow. - Consolidated the OpenAPI specification files into a single `src/openapi.yaml` file. - Removed redundant scripts and files.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit performs a comprehensive overhaul of the repository to establish a robust foundation for future development, maintainability, and team collaboration.
The following changes were made:
/src,/docs,/tests, and/scriptsdirectories and moving the relevant files into them.README.md, creating aCONTRIBUTING.md, and adding GitHub issue and pull request templates..editorconfig,.prettierrc,.prettierignore, and.spectral.yaml. Added Prettier and formatted the codebase..gitignoreand updatingpackage.jsonwith the necessary dev dependencies.lint,format, andtestscripts topackage.jsonand creating a GitHub Actions CI workflow.src/openapi.yamlfile.