Skip to content

Add Contributor Covenant Code of Conduct#11

Merged
twangodev merged 5 commits intomainfrom
code-of-conduct
Oct 18, 2025
Merged

Add Contributor Covenant Code of Conduct#11
twangodev merged 5 commits intomainfrom
code-of-conduct

Conversation

@twangodev
Copy link
Owner

This document outlines the Code of Conduct for community members, detailing pledges, standards, enforcement responsibilities, and consequences for violations.

This document outlines the Code of Conduct for community members, detailing pledges, standards, enforcement responsibilities, and consequences for violations.
Copilot AI review requested due to automatic review settings October 18, 2025 09:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 18, 2025

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 @coderabbitai review command as a PR comment. 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 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 116ffe7 and 713bcdb.

📒 Files selected for processing (2)
  • CODE_OF_CONDUCT.md (1 hunks)
  • CONTRIBUTING.md (1 hunks)

Note

Other AI code review bot(s) detected

CodeRabbit 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)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch code-of-conduct

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@twangodev twangodev enabled auto-merge October 18, 2025 09:08
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 18, 2025 09:08
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@twangodev twangodev merged commit b8b8814 into main Oct 18, 2025
9 checks passed
@twangodev twangodev deleted the code-of-conduct branch October 18, 2025 09:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 .
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
> 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).

Copilot uses AI. Check for mistakes.
## 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.
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use American English consistently; change 'licence' to 'license' to match the rest of the document's US spelling (e.g., 'behavior').

Suggested change
> 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.

Copilot uses AI. Check for mistakes.
Comment on lines +129 to +148
<!-- 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 -->

Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
<!-- 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
  1. Set up your development environment:
    You can use any IDE or editor of your choice (e.g., VS Code, WebStorm).
  2. Run the project locally:
    npm start
  3. Run tests before submitting changes:
    npm test
  4. Lint your code to ensure style consistency:
    npm run lint
  5. Create a new branch for your feature or bugfix.
  6. Make your changes, commit them, and push to your fork.
  7. Open a Pull Request on GitHub and fill out the PR template.

Improving The Documentation

To update, improve, or correct the documentation:

  1. Edit the relevant markdown files in the docs/ or root directory.
  2. Ensure your changes are clear, concise, and follow the existing style.
  3. If adding new documentation, update the Table of Contents as needed.
  4. Commit your changes with a descriptive message (see Commit Messages below).
  5. 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!

Copilot uses AI. Check for mistakes.
Comment on lines +134 to +139
### Improving The Documentation
<!-- TODO
Updating, improving and correcting the documentation

-->

Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
### Improving The Documentation
<!-- TODO
Updating, improving and correcting the documentation
-->

Copilot uses AI. Check for mistakes.
Comment on lines +142 to +145
<!-- TODO

-->

Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
<!-- 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/).

Copilot uses AI. Check for mistakes.
Comment on lines +146 to +148
## Join The Project Team
<!-- TODO -->

Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is empty. Either document the process (roles, expectations, how to apply) or remove it to avoid confusing contributors.

Suggested change
## Join The Project Team
<!-- TODO -->

Copilot uses AI. Check for mistakes.

- 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.
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize the proper name 'Node.js' correctly.

Suggested change
- 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.

Copilot uses AI. Check for mistakes.
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.

2 participants