docs(contribution-guideline): Update contribution guidelines #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the contribution guideline document for the project. The document now requires contributors to agree to distribute their work under the GNU GENERAL PUBLIC LICENSE. Additionally, it encourages improving comments, writing tests, and allows contributions of varying complexity. The changes ensure that contributors are aware of the licensing requirements and provide clear guidelines for their contributions. Signed-off-by: Rodney Osodo <[email protected]>
…l request guidelines, and spell check workflow script - Added new files to directory - Included code snippet for feature request template - Made code changes in two files - Provided guidelines for creating pull requests - Added script for Flutter project with spell check workflow Signed-off-by: Rodney Osodo <[email protected]>
The appearance of buttons and icons in the mobile application's control panel and home page has been modified to enhance visibility and improve usability. This change aims to make it easier for users to interact with the application. A test has also been added to verify the functionality of the counter increment in the application. No further details provided in the Git diff. Signed-off-by: Rodney Osodo <[email protected]>
Added a new file SECURITY.md that provides information on how to report security vulnerabilities in the nairobi-traffic-pcb project. The file includes instructions on reporting vulnerabilities through GitHub issues and provides guidelines on the information to include in the report. This will help users and contributors to responsibly disclose security issues and ensure prompt response and resolution. Signed-off-by: Rodney Osodo <[email protected]>
This commit adds a new SUPPORT.md file to provide guidelines and insights on where to find assistance with the nairobi-traffic-pcb projects. The file includes information on formulating questions, conducting searches, providing relevant code samples, and the importance of investing effort in framing questions effectively. It also includes a note to read the code of conduct before participating in the community. The purpose of this commit is to improve the documentation and support resources for the project. Signed-off-by: Rodney Osodo <[email protected]>
|
Warning Rate Limit Exceeded@rodneyosodo has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 12 minutes and 29 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per repository. WalkthroughThe project "nairobi-traffic-pcb" has undergone a series of enhancements, primarily focusing on improving the project's GitHub workflows and community health files. The changes include the addition of issue templates, Dependabot configuration, pull request template, GitHub Actions workflows, and community guidelines. Additionally, minor adjustments have been made to the mobile application's UI components. Changes
Poem
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (14)
- .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
- .github/ISSUE_TEMPLATE/config.yml (1 hunks)
- .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
- .github/dependabot.yml (1 hunks)
- .github/pull_request_template.md (1 hunks)
- .github/workflows/ci.yaml (1 hunks)
- .github/workflows/spell-check.yml (1 hunks)
- CODE_OF_CONDUCT.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- SECURITY.md (1 hunks)
- SUPPORT.md (1 hunks)
- mobile/nairobitrafficpcb/lib/pages/control_panel/widgets/mode_widget.dart (1 hunks)
- mobile/nairobitrafficpcb/lib/pages/home/widgets/devices.dart (1 hunks)
- mobile/nairobitrafficpcb/test/widget_test.dart (1 hunks)
Files skipped from review due to trivial changes (9)
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/ISSUE_TEMPLATE/config.yml
- .github/dependabot.yml
- .github/pull_request_template.md
- .github/workflows/ci.yaml
- CONTRIBUTING.md
- SECURITY.md
- SUPPORT.md
- mobile/nairobitrafficpcb/lib/pages/control_panel/widgets/mode_widget.dart
Additional comments: 4
CODE_OF_CONDUCT.md (1)
- 1-128: The addition of a Code of Conduct is a good practice for open source projects. It sets the tone for how contributors should interact and what behavior is acceptable. This particular Code of Conduct is comprehensive and covers a wide range of scenarios. Ensure that all contributors are aware of this Code of Conduct and agree to abide by it.
.github/ISSUE_TEMPLATE/feature_request.yml (1)
- 1-39: The feature request template is well-structured and covers all the necessary aspects of a feature request. It ensures that the user provides enough information for the developers to understand the request. The use of checkboxes and text areas makes the template interactive and easy to use. The validation requirements ensure that necessary information is not left out. The ability to attach files is a good addition as it allows users to provide additional context if necessary.
mobile/nairobitrafficpcb/test/widget_test.dart (1)
- 5-12: The test case 'Counter increments smoke test' has been removed. Ensure that the functionality it was testing is either no longer needed or is covered by another test. If not, consider adding a new test case.
- testWidgets('Counter increments smoke test', (WidgetTester tester) async {}); + // Add new test case here if neededmobile/nairobitrafficpcb/lib/pages/home/widgets/devices.dart (1)
- 56-60: The color property of the SvgPicture.asset widget has been removed. This means that the SVG image will no longer change color based on the
isActiveproperty of thedeviceobject. Ensure that this change aligns with the intended design and user experience.- SvgPicture.asset( - 'assets/svg/light.svg', - color: device.isActive ? Colors.white : Colors.black, - height: 30, - ), + SvgPicture.asset( + 'assets/svg/light.svg', + height: 30, + ),
Updated the project directory path in the CI workflow to the correct location for the Flutter project. Previously, it was set to "nairobi-traffic-pcb" but it should be "mobile/nairobitrafficpcb" to match the actual project structure. Signed-off-by: Rodney Osodo <[email protected]>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- .github/workflows/ci.yaml (1 hunks)
- .github/workflows/spell-check.yml (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/workflows/ci.yaml
Additional comments: 1
.github/workflows/spell-check.yml (1)
- 1-22: The spell check workflow looks good. It's triggered on push, pull request, schedule, workflow dispatch, and repository dispatch events. It uses the latest version of Ubuntu and the
actions/checkout@v4action to fetch the repository code. Thecodespell-project/actions-codespell@v2action is used to perform spell checking.
Updated the version of actions-codespell from master to v2 in the spell-check workflow. Signed-off-by: Rodney Osodo <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Bug Fixes
isActiveproperty.Documentation
Chores
Tests