Skip to content

feat(docs): define contribution guidelines and update README - #10

Merged
saqibbedar merged 1 commit into
mainfrom
feat/docs
Oct 3, 2026
Merged

saqibbedar merged 1 commit into
mainfrom
feat/docs

Conversation

@saqibbedar

Copy link
Copy Markdown
Owner
  • add code_quality script to run auto ruff tests and generate logs

📝 Description

  • Defined contribution guidelines and updated README.
  • added code_quality script to run auto ruff tests and generate logs
  • defined Justfile to quickly run code_quality test using just code_quality

🎯 Type of Change

  • 🐛 Bug fix (non-breaking change fixing an issue)
  • [ x ] ✨ New feature (non-breaking change adding functionality)
  • [ x ] 🧹 Refactoring / Code cleanup
  • [ x ] 📚 Documentation updates

🧪 How Has This Been Tested?

  • [ x ] Manually tested edge cases (e.g., tested ZeroDivisionError messaging)
  • [ x ] Automated tests pass (if applicable)

📋 Pre-Merge Checklist

  • [ x ] My code follows the code style of this project
  • [ x ] I have performed a self-review of my own code
  • [ x ] I have commented on my code, particularly in hard-to-understand areas

- add code_quality script to run auto ruff tests and generate logs
- define Justfile to quickly run code_quality test using just

@saqibbedar saqibbedar left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Ready for merge.

@saqibbedar
saqibbedar merged commit 0c67461 into main Oct 3, 2026
1 check passed
@saqibbedar
saqibbedar deleted the feat/docs branch October 3, 2026 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant