Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve repository with documentation, tests, and CI enhancements #74

Closed
wants to merge 1 commit into from

Conversation

GreatV
Copy link
Owner

@GreatV GreatV commented Nov 8, 2024

Add contributing guidelines, unit tests, and documentation enhancements.

  • CONTRIBUTING.md: Add guidelines for contributing, setting up the development environment, and running tests.
  • tests/unit_tests.rs: Add unit tests for major functions and edge cases in src/main.rs.
  • README.md: Enhance documentation with detailed examples, usage instructions, and a section on how to contribute.
  • CHANGELOG.md: Add a changelog to track changes, improvements, and bug fixes.
  • .github/workflows/publish.yml: Add steps to run tests and lint code in the GitHub Actions workflow.
  • .github/ISSUE_TEMPLATE/bug_report.md: Create an issue template for reporting bugs.
  • .github/ISSUE_TEMPLATE/feature_request.md: Create an issue template for requesting new features.
  • CODE_OF_CONDUCT.md: Include a code of conduct to create a welcoming and inclusive environment for contributors.

For more details, open the Copilot Workspace session.

Add contributing guidelines, unit tests, and documentation enhancements.

* **CONTRIBUTING.md**: Add guidelines for contributing, setting up the development environment, and running tests.
* **tests/unit_tests.rs**: Add unit tests for major functions and edge cases in `src/main.rs`.
* **README.md**: Enhance documentation with detailed examples, usage instructions, and a section on how to contribute.
* **CHANGELOG.md**: Add a changelog to track changes, improvements, and bug fixes.
* **.github/workflows/publish.yml**: Add steps to run tests and lint code in the GitHub Actions workflow.
* **.github/ISSUE_TEMPLATE/bug_report.md**: Create an issue template for reporting bugs.
* **.github/ISSUE_TEMPLATE/feature_request.md**: Create an issue template for requesting new features.
* **CODE_OF_CONDUCT.md**: Include a code of conduct to create a welcoming and inclusive environment for contributors.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/GreatV/labelme2yolo?shareId=XXXX-XXXX-XXXX-XXXX).
@GreatV GreatV closed this Nov 10, 2024
@GreatV GreatV deleted the improve-repository branch November 10, 2024 09:40
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