feat: 👷 Add Conventions Verification Tools and Automation#8
Merged
nedseb merged 3 commits intoOct 29, 2024
Merged
Conversation
f5f92cf to
269e632
Compare
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
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 pull request implements the automated verification of conventions for the
makecode-steamirepository as described in issue #7. The following tools and configurations were added to ensure consistency, quality, and streamline the development process:ESLint: Added ESLint for code linting, enforcing consistent code style and identifying potential issues. Configurations were added to enforce the project's coding standards.
Prettier: Integrated Prettier for code formatting, ensuring that all files are formatted uniformly according to the defined style. Configurations were added, and scripts were updated to apply formatting automatically.
lint-staged: Configured
lint-stagedto run ESLint and Prettier on staged files before committing, ensuring that only properly formatted and linted code is committed.Commitlint: Added Commitlint to verify that commit messages follow the Conventional Commits standard, enforcing consistency in commit history.
Commitizen: Integrated Commitizen to assist developers in writing properly formatted commit messages, making it easier to adhere to Conventional Commits.
validate-branch-name: Configured branch name validation to enforce a naming convention inspired by GitHub Flow, ensuring clear and consistent branch names.
Semantic-release: Implemented
semantic-releaseto automate versioning and changelog generation. A new GitHub Action was added to handle the release process automatically based on Conventional Commits.Additionally, I set up hooks that are automatically configured the first time dependencies are installed. These hooks ensure that
lint-staged, Commitlint, and branch name validation are executed at appropriate stages of the development process, further reducing the chances of inconsistent or incorrect contributions.All relevant scripts have been added to the
package.jsonfile to facilitate the usage of these tools, and the configuration files have been included to adapt these tools to our project standards.Summary of Changes:
These changes aim to automate the verification of repository conventions, ensuring a high level of code quality and reducing the need for manual intervention.
Please review these changes and let me know if there are any suggestions or improvements required.
Thank you!