-
Notifications
You must be signed in to change notification settings - Fork 3.1k
task3 #3232
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
task3 #3232
Conversation
This document outlines the guidelines for contributing to the development of Shipping Rates and Calculations, including code style, documentation, testing, issue tracking, and code review.
Removed introductory section and copyright notice.
Added input and output format details for the calculator.
|
Congratulations! You have completed the lab. Closing for maintainence purpose. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request updates documentation files with a focus on improving contribution guidelines and fixing minor formatting issues. The changes include a formatting correction to the README, a complete rewrite of the contributing guidelines, and a modification to the Code of Conduct.
- Fixed formatting in README.md by adding proper line numbering and colon to "Output:"
- Replaced basic CONTRIBUTING.md welcome message with comprehensive contribution guidelines
- Added a signature line to CODE_OF_CONDUCT.md
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Fixed formatting by adding colon to "Output:" label |
| CONTRIBUTING.md | Complete rewrite with detailed contribution guidelines covering code style, documentation, testing, issue tracking, and code review process |
| CODE_OF_CONDUCT.md | Added personal signature line at the end of the document |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1 +1,20 @@ | |||
| All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. | |||
| Contribution guidelines | |||
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing article in the title. Should be "Contribution Guidelines" (with capital G for consistency with other section headings) or use proper article format.
| Contribution guidelines | |
| Contribution Guidelines |
| All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. | ||
| Contribution guidelines | ||
| Welcome Contributors! | ||
| Thank you for considering contributing to the centralized repository. This document outlines the guidelines for contributing to the development of Shipping Rates and Calculations. |
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reference to "Shipping Rates and Calculations" appears to be incorrect or copied from another project. This should describe the actual purpose of this repository, not a shipping rates project.
| Thank you for considering contributing to the centralized repository. This document outlines the guidelines for contributing to the development of Shipping Rates and Calculations. | |
| Thank you for considering contributing to the centralized repository. This document outlines the guidelines for contributing to the development and improvement of this project. |
| Code style | ||
| Please follow the coding style and conventions used in the existing codebase. This helps maintain consistency across the project. | ||
|
|
||
| Documentation | ||
| Ensure that your contributions are well-documented. Include comments in your code where necessary and provide a clear and concise description of your changes in the pull request. | ||
|
|
||
| Testing | ||
| Before submitting a pull request, make sure your changes have been tested thoroughly. Include relevant test cases and ensure that existing tests pass. | ||
|
|
||
| Issue tracker | ||
| Check the issue tracker for any open issues or feature requests. If you're working on something, please comment on the issue to let others know. | ||
|
|
||
| Code review |
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Section headings should use proper markdown heading syntax (e.g., ## Code Style) for better document structure and consistency. Currently these appear as plain text rather than formatted headings.
| Code style | |
| Please follow the coding style and conventions used in the existing codebase. This helps maintain consistency across the project. | |
| Documentation | |
| Ensure that your contributions are well-documented. Include comments in your code where necessary and provide a clear and concise description of your changes in the pull request. | |
| Testing | |
| Before submitting a pull request, make sure your changes have been tested thoroughly. Include relevant test cases and ensure that existing tests pass. | |
| Issue tracker | |
| Check the issue tracker for any open issues or feature requests. If you're working on something, please comment on the issue to let others know. | |
| Code review | |
| ## Code style | |
| Please follow the coding style and conventions used in the existing codebase. This helps maintain consistency across the project. | |
| ## Documentation | |
| Ensure that your contributions are well-documented. Include comments in your code where necessary and provide a clear and concise description of your changes in the pull request. | |
| ## Testing | |
| Before submitting a pull request, make sure your changes have been tested thoroughly. Include relevant test cases and ensure that existing tests pass. | |
| ## Issue tracker | |
| Check the issue tracker for any open issues or feature requests. If you're working on something, please comment on the issue to let others know. | |
| ## Code review |
No description provided.