feat: add examples directory with usage scripts#19
feat: add examples directory with usage scripts#19Nabilhassan12345 wants to merge 2 commits intoOpenSource-Communities:mainfrom
Conversation
There was a problem hiding this comment.
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
775e305 to
0fc9b9a
Compare
- 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
|
Hey @Nabilhassan12345, However, we will close this PR with following reasons:
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. |
Description
This PR implements the examples directory as requested in issue #9, providing practical usage scripts and demonstrations for RepoReady.
Changes Made
examples/directory structureFiles Added
examples/README.md- Main documentationexamples/basic/- 3 basic usage examplesexamples/advanced/- 4 advanced examplesexamples/integrations/- 3 integration examplesexamples/data/- 2 sample data filesTesting
npm run buildandexport GITHUB_TOKEN=your_tokenCloses #9