Skip to content

[Chore] Update contributing guidelines and local setup documentation#62

Merged
Gautam25Raj merged 1 commit into
masterfrom
chore/contributing-guidelines-and-local-setup-update
May 20, 2026
Merged

[Chore] Update contributing guidelines and local setup documentation#62
Gautam25Raj merged 1 commit into
masterfrom
chore/contributing-guidelines-and-local-setup-update

Conversation

@Gautam25Raj
Copy link
Copy Markdown
Collaborator

Summary

This PR updates the contributing guidelines and local development setup instructions to improve onboarding clarity, contributor workflows, and overall developer experience.

Improvements

Contributing Guidelines

  • Updated contributing documentation for better clarity
  • Improved contribution workflow explanations
  • Refined project collaboration guidance and expectations

Local Development Setup

  • Improved local setup instructions for easier onboarding
  • Clarified development environment configuration steps
  • Updated workflow documentation for improved consistency

Documentation Enhancements

  • Improved readability and organization across setup documentation
  • Simplified developer onboarding experience
  • Enhanced maintainability of contributor documentation

Notes

  • No breaking changes
  • Focused on contributor experience and development workflow clarity

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🧪 Tests (adding or updating tests)

Checklist

  • I have read the CONTRIBUTING.md document.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

@Gautam25Raj Gautam25Raj added the documentation Improvements or additions to documentation label May 20, 2026
@Gautam25Raj Gautam25Raj merged commit 5bc49d0 into master May 20, 2026
1 check failed
@Gautam25Raj Gautam25Raj deleted the chore/contributing-guidelines-and-local-setup-update branch May 22, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant