chore: improve code quality and documentation#3
Open
AungMyoKyaw wants to merge 1 commit into
Open
Conversation
- Enhance .gitignore with comprehensive entries for IDE, OS, and temp files - Update .npmignore to properly exclude dev files from npm package - Add Project Structure and Contributing sections to README - Add Changelog link to README for better documentation - Standardize type interfaces (ChineseZodiacResult, ZodiacResult) with consistent `en`/`my` properties while maintaining backward compatibility via deprecated `sign`/`signInBurmese`/`sign_mm` properties
There was a problem hiding this comment.
Pull request overview
This PR improves code quality and documentation by standardizing type interfaces and enhancing configuration files. It makes the codebase more consistent and professional without introducing breaking changes.
Changes:
- Standardized
ChineseZodiacResultandZodiacResultinterfaces to useen/myproperties (matchingLocalizedStringconvention) while maintaining deprecated properties for backward compatibility - Enhanced
.gitignoreand.npmignorewith comprehensive patterns for IDE files, OS files, test coverage, and config files - Added detailed Project Structure and Contributing sections to README with file descriptions and development guidelines
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/types.ts |
Standardized zodiac result interfaces with en/my properties and deprecated old properties |
src/lib/baydin.ts |
Updated zodiac functions to return both new and deprecated properties for backward compatibility |
README.md |
Added Project Structure section and Contributing guidelines |
.gitignore |
Added comprehensive ignore patterns for IDE, OS, coverage, and temporary files |
.npmignore |
Improved package exclusions for config files, bench folder, and lock files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
This PR improves code quality and documentation across the repository:
Enhanced .gitignore: Added comprehensive entries for IDE files (.idea, .vscode), OS generated files (.DS_Store, Thumbs.db), test coverage, environment files, logs, and temporary files
Updated .npmignore: Improved exclusions for npm package publishing, including config files (eslint, prettier, tsconfig), bench folder, and lock files
Improved README: Added Project Structure section with detailed file descriptions and Contributing section with guidelines for code style and PR process
Standardized Type Interfaces: Made
ChineseZodiacResultandZodiacResultconsistent with other localized types by usingen/myproperties. Maintained backward compatibility by keeping deprecatedsign/signInBurmese/sign_mmpropertiesTest plan
bun test)bun run typecheck)bun run lint)Changes
.gitignore.npmignoreREADME.mdsrc/types.tssrc/lib/baydin.ts