Skip to content

Conversation

@Nabilhassan12345
Copy link

Description

This PR implements the examples directory as requested in issue #9, providing practical usage scripts and demonstrations for RepoReady.

Changes Made

  • ✅ Created examples/ directory structure
  • ✅ Added basic usage examples (evaluate-popular-repos, create-interactive, evaluate-with-token)
  • ✅ Added advanced examples (batch-evaluate, compare-repositories, export-results, check-org-repos)
  • ✅ Added integration examples (GitHub Actions, pre-commit hook, Slack integration)
  • ✅ Added sample data files and expected results
  • ✅ Added comprehensive README with usage instructions

Files Added

  • examples/README.md - Main documentation
  • examples/basic/ - 3 basic usage examples
  • examples/advanced/ - 4 advanced examples
  • examples/integrations/ - 3 integration examples
  • examples/data/ - 2 sample data files

Testing

  • All examples are executable and well-documented
  • Examples handle rate limits and errors gracefully
  • Ready for users to run with npm run build and export GITHUB_TOKEN=your_token

Closes #9

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Protected Branch

In order to be considered for merging, the pull request changes must not be implemented on the "main" branch.
We would suggest that you close this pull request, create a new branch, implement your changes, and open a new pull request.

- Add basic usage examples (evaluate-popular-repos, create-interactive, evaluate-with-token)
- Add advanced examples (batch-evaluate, compare-repositories, export-results, check-org-repos)
- Add integration examples (GitHub Actions, pre-commit hook, Slack integration)
- Add sample data files and expected results
- Add comprehensive README with usage instructions

Closes OpenSource-Communities#9
- Add basic usage examples (evaluate-popular-repos, create-interactive, evaluate-with-token)
- Add advanced examples (batch-evaluate, compare-repositories, export-results, check-org-repos)
- Add integration examples (GitHub Actions, pre-commit hook, Slack integration)
- Add sample data files and expected results
- Add comprehensive README with usage instructions

Closes OpenSource-Communities#9
@Nabilhassan12345 Nabilhassan12345 changed the title Create examples directory with usage scripts #9 feat: add examples directory with usage scripts Oct 18, 2025
@adiati98
Copy link
Contributor

adiati98 commented Oct 18, 2025

Hey @Nabilhassan12345,
Thank you for taking on this! We appreciate your contribution. ✨

However, we will close this PR with following reasons:

  • You made the changes directly on the main branch, and we don't allow that. Please refer to this bot message.

Please create a new branch to work on your changes.

For the next, kindly ask to be assigned to the issue. For now, we'll assign you to the issue.
Please comment on the issue so we can assign it to you.

@adiati98 adiati98 closed this Oct 18, 2025
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.

Create examples directory with usage scripts

2 participants