Conversation
This document outlines the Code of Conduct for community members, detailing pledges, standards, enforcement responsibilities, and consequences for violations.
|
Warning Rate limit exceeded@twangodev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 7 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull Request Overview
Adds a Contributor Covenant Code of Conduct document to establish community standards, enforcement, and attribution.
- Introduces Contributor Covenant content (v2.0) with standards and enforcement guidelines
- Provides a reporting contact email
- Includes attribution and reference links
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Added a comprehensive CONTRIBUTING.md file to guide contributors on how to participate in the project, report bugs, and suggest enhancements.
Create CONTRIBUTING.md for project contribution guidelines
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| <!-- omit in toc --> | ||
| #### How Do I Submit a Good Bug Report? | ||
|
|
||
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . |
There was a problem hiding this comment.
The security reporting email is missing, which prevents responsible disclosure. Please provide a valid contact (for example, security@ogis.dev) or link to a SECURITY.md; alternatively, reuse the existing conduct@ogis.dev inbox for security reports.
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . | |
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to [conduct@ogis.dev](mailto:conduct@ogis.dev). |
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice <!-- omit in toc --> | ||
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence. |
There was a problem hiding this comment.
Use American English consistently; change 'licence' to 'license' to match the rest of the document's US spelling (e.g., 'behavior').
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence. | |
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. |
| <!-- TODO | ||
| include Setup of env, IDE and typical getting started instructions? | ||
|
|
||
| --> | ||
|
|
||
| ### Improving The Documentation | ||
| <!-- TODO | ||
| Updating, improving and correcting the documentation | ||
|
|
||
| --> | ||
|
|
||
| ## Styleguides | ||
| ### Commit Messages | ||
| <!-- TODO | ||
|
|
||
| --> | ||
|
|
||
| ## Join The Project Team | ||
| <!-- TODO --> | ||
|
|
There was a problem hiding this comment.
This section is left as a TODO. Either provide initial setup and contribution steps (environment setup, build/test commands, how to run linters) or remove the section from the ToC until it’s ready.
| <!-- TODO | |
| include Setup of env, IDE and typical getting started instructions? | |
| --> | |
| ### Improving The Documentation | |
| <!-- TODO | |
| Updating, improving and correcting the documentation | |
| --> | |
| ## Styleguides | |
| ### Commit Messages | |
| <!-- TODO | |
| --> | |
| ## Join The Project Team | |
| <!-- TODO --> | |
| To get started with contributing code to ogis, follow these steps: | |
| 1. **Fork the repository** and clone it to your local machine. | |
| 2. **Install dependencies**: | |
| ```bash | |
| npm install |
- Set up your development environment:
You can use any IDE or editor of your choice (e.g., VS Code, WebStorm). - Run the project locally:
npm start
- Run tests before submitting changes:
npm test - Lint your code to ensure style consistency:
npm run lint
- Create a new branch for your feature or bugfix.
- Make your changes, commit them, and push to your fork.
- Open a Pull Request on GitHub and fill out the PR template.
Improving The Documentation
To update, improve, or correct the documentation:
- Edit the relevant markdown files in the
docs/or root directory. - Ensure your changes are clear, concise, and follow the existing style.
- If adding new documentation, update the Table of Contents as needed.
- Commit your changes with a descriptive message (see Commit Messages below).
- Open a Pull Request and describe the documentation improvements.
Styleguides
Commit Messages
Please follow these guidelines for commit messages:
- Use the present tense ("Add feature" not "Added feature")
- Start with a short summary (max 50 characters)
- Separate subject from body with a blank line
- Explain the motivation for the change in the body, if necessary
- Reference issues and pull requests when relevant (e.g., "Fixes chore(deps-dev): bump svelte from 5.47.0 to 5.51.5 #123")
Join The Project Team
If you are interested in joining the ogis project team:
- Reach out via GitHub Discussions or open an issue expressing your interest.
- Tell us about your background and how you'd like to help.
- We welcome maintainers, reviewers, and contributors of all experience levels!
| ### Improving The Documentation | ||
| <!-- TODO | ||
| Updating, improving and correcting the documentation | ||
|
|
||
| --> | ||
|
|
There was a problem hiding this comment.
The 'Improving The Documentation' section is a placeholder. Add concrete guidance (doc structure, style guide, how to run docs build/preview, where to file doc issues) or omit it from the document for now.
| ### Improving The Documentation | |
| <!-- TODO | |
| Updating, improving and correcting the documentation | |
| --> |
| <!-- TODO | ||
|
|
||
| --> | ||
|
|
There was a problem hiding this comment.
Commit message conventions are marked TODO. Consider adding the project's standard (e.g., Conventional Commits), with examples and scope rules, or remove this section until defined.
| <!-- TODO | |
| --> | |
| This project uses the [Conventional Commits](https://www.conventionalcommits.org/) standard for commit messages. Please format your commit messages as follows: | |
[optional scope]:
**Types**:
- `feat`: A new feature
- `fix`: A bug fix
- `docs`: Documentation only changes
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- `refactor`: A code change that neither fixes a bug nor adds a feature
- `perf`: A code change that improves performance
- `test`: Adding missing tests or correcting existing tests
- `chore`: Changes to the build process or auxiliary tools and libraries such as documentation generation
**Scope** (optional): Use to specify the part of the codebase affected, e.g. `api`, `docs`, `core`.
**Examples**:
- `feat(api): add user authentication`
- `fix(core): handle null pointer exception`
- `docs: update contributing guide`
For more details, see [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
| ## Join The Project Team | ||
| <!-- TODO --> | ||
|
|
There was a problem hiding this comment.
This section is empty. Either document the process (roles, expectations, how to apply) or remove it to avoid confusing contributors.
| ## Join The Project Team | |
| <!-- TODO --> |
|
|
||
| - Open an [Issue](https://github.com/twangodev/ogis/issues/new). | ||
| - Provide as much context as you can about what you're running into. | ||
| - Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. |
There was a problem hiding this comment.
Capitalize the proper name 'Node.js' correctly.
| - Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. | |
| - Provide project and platform versions (Node.js, npm, etc), depending on what seems relevant. |
This document outlines the Code of Conduct for community members, detailing pledges, standards, enforcement responsibilities, and consequences for violations.