Refactor gem repo to AppTweak development' standards & style #1
Conversation
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
- Add new gems for code quality and development tools. -vCreate Gemfile.lock to lock gem versions.
…onsistency and clarity.
- Introduced .editorconfig for consistent coding styles. - Added .rubocop.yml for RuboCop configuration with performance and additional requirements. - Created .pronto.yml for default commit settings. - Set up lefthook.yml for pre-commit and pre-push hooks to run Pronto. - Added a script for pre-commit to run Pronto only on the main branch.
…ter environment management and development workflow.
- Introduced a new gemspec file for the yard-apptweak-template gem. - Defined gem metadata, dependencies, and file specifications.
- Introduced a new console script for interactive experimentation with the gem. - Added a release management script to handle version bumps, commits, and tagging. - Created a setup script to automate the installation of dependencies and hooks.
- Introduced a CODEOWNERS file to define default reviewers for pull requests. - Added a workflow for Pronto to run on pull request events for code quality checks. - Created a workflow for publishing the gem upon tag pushes, automating the release process.
- Changed the project name from SketchUp Ruby API YARD Template to AppTweak Ruby YARD Template. - Added sections for Installation, Development Scripts, Configuration, Usage, and Contributing. - Updated example commands and configuration to reflect the new template name and structure. - Included contact information for the AppTweak Developer Experience team.
- Introduced custom error classes for better error management during the release process. - Implemented rollback mechanisms to revert changes in case of errors at various phases of the release. - Enhanced the `do!` method to handle exceptions and provide informative messages. - Updated methods to track the current phase of the release process for improved error reporting.
… beta version bumping - Added a condition to prevent opening the release page for beta versions. - Improved error message for failure to open the release page, enhancing clarity. - Updated directory check error message to reflect the actual parent directory path.
…elease page. - Enhance ReleaseManager with improved error handling and GitHub release page management - Updated messages for clarity and consistency, particularly regarding the success of tag pushes. - Improved documentation for methods with additional comments on error raising.
This reverts commit 0a553c8.
- Updated the ReleaseManager class to provide a comprehensive overview of the release process for Apptweak Ruby gems. - Added detailed comments explaining the steps involved in version bumping, commit creation, and tag management. - Included rollback capabilities to ensure repository integrity in case of errors during the release process. - Implemented restrictions on version bump options when running on non-main branches to prevent accidental major releases.
Naming/FileName: The name of this source file (`yard-apptweak-template.rb`) should use snake_case. (https://rubystyle.guide#snake-case-files)
Dakad
force-pushed
the
misc/davida/refactor-repo-to-apptweak-standard
branch
from
69e336f to
9a5eef9
Compare
Dakad
changed the title
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.
What does this PR do?
Improves documentation by fixing formatting issues, enhancing content organization to match AppTweak standards/styles, and adding documentation for development scripts.
Key changes include:
Associated ticket number and/or AirBrake error?
/
Due Date or Desirable Merge
No specific timeline, can be merged when convenient.
How has this been tested?
Changes are documentation-only and have been visually verified for correct formatting.
No spec present to run 😢
Anticipated impact
no code changes that would impact functionality.
How do you plan to monitor the change in prod to make sure it's working?
Checklist
[ ] This has been tested on staging.