Skip to content

Commit 6822bb1

Browse files
author
Buddhi Dhananjaya
committed
✨(docs) add upgrade and security policy documentation
1 parent 61b36c4 commit 6822bb1

File tree

5 files changed

+245
-17
lines changed

5 files changed

+245
-17
lines changed

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. We just want tp make meeting bots available to everyone.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
- Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
- Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
31+
32+
## Scope
33+
34+
- This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
35+
36+
## Enforcement
37+
38+
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at docs@numerique.gouv.fr.
39+
40+
- All complaints will be reviewed and investigated promptly and fairly.
41+
42+
- All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
- Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this
47+
48+
## Code of Conduct:
49+
50+
1. Correction
51+
52+
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53+
54+
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. 2. Warning
55+
56+
Community Impact: A violation through a single incident or series of actions.
57+
58+
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. 3. Temporary Ban
59+
60+
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
61+
62+
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. 4. Permanent Ban
63+
64+
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
65+
66+
Consequence: A permanent ban from any sort of public interaction within the community.
67+
Attribution
68+
69+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
70+
71+
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
72+
73+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing to the Project
2+
3+
Thank you for taking the time to contribute! Please follow these guidelines to ensure a smooth and productive workflow. 🚀🚀🚀
4+
5+
To get started with the project, please refer to the [documentaton](https://cuemeet.github.io/cuemeet-documentation/) for detailed instructions.
6+
7+
## Creating an Issue
8+
9+
When creating an issue, please provide the following details:
10+
11+
1. **Title**: A concise and descriptive title for the issue.
12+
2. **Description**: A detailed explanation of the issue, including relevant context or screenshots if applicable.
13+
3. **Steps to Reproduce**: If the issue is a bug, include the steps needed to reproduce the problem.
14+
4. **Expected vs. Actual Behavior**: Describe what you expected to happen and what actually happened.
15+
5. **Labels**: Add appropriate labels to categorize the issue (e.g., bug, feature request, documentation).
16+
17+
## Selecting an issue
18+
19+
We will be launching a public issue board soon.
20+
21+
Please check in priority the issues that are in the **todo** column and have a higher priority (P0 -> P2).
22+
23+
## Commit Message Format
24+
25+
All commit messages must adhere to the following format:
26+
27+
`<gitmoji>(type) title description`
28+
29+
- <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
30+
- **(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
31+
- **title**: A short, descriptive title for the change.
32+
- **description**: Include additional details about what was changed and why.
33+
34+
### Example Commit Message
35+
36+
```
37+
✨(frontend) add user authentication logic
38+
39+
Implemented login and signup features, and integrated OAuth2 for social login.
40+
```
41+
42+
## Changelog Update
43+
44+
Please add a line to the changelog describing your development. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. We usually include the title of the pull request, followed by the pull request ID to finish the log entry. The changelog line should be less than 80 characters in total.
45+
46+
### Example Changelog Message
47+
48+
```
49+
## [Unreleased]
50+
51+
## Added
52+
53+
- ✨(frontend) add AI to the project #321
54+
```
55+
56+
## Pull Requests
57+
58+
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
59+
60+
### Don't forget to:
61+
62+
- check your commits
63+
- check the linting: `make lint && make frontend-lint`
64+
- check the tests: `make test`
65+
- add a changelog entry
66+
67+
Once all the required tests have passed, you can request a review from the project maintainers.
68+
69+
## Code Style
70+
71+
Please maintain consistency in code style. Run any linting tools available to make sure the code is clean and follows the project's conventions.
72+
73+
## Tests
74+
75+
Make sure that all new features or fixes have corresponding tests. Run the test suite before pushing your changes to ensure that nothing is broken.
76+
77+
## Asking for Help
78+
79+
If you need any help while contributing, feel free to open a discussion or ask for guidance in the issue tracker. We are more than happy to assist!
80+
81+
Thank you for your contributions! 👍

README.md

Lines changed: 53 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# CueMeet Documentation
1+
<div align="center">
2+
<img src="https://i.postimg.cc/FRLZLSSF/Banner.png" alt="Meeting Bots Control Panel Banner" />
3+
<h1>CueMeet Documentation</h1>
4+
</div>
5+
6+
---
7+
## Links to CueMeet Repositories
8+
9+
You can explore all our repositories for additional tools and integrations:
10+
11+
<ul>
12+
<li><a href="https://github.com/CueMeet/cuemeet-documentation" target="_blank">CueMeet Docs</a></li>
13+
<li><a href="https://github.com/CueMeet/Meeting-Bots-Control-Panel" target="_blank">CueMeet Control Panel</a></li>
14+
<li><a href="https://github.com/CueMeet/cuemeet-google-bot" target="_blank">Google Meet Bot</a></li>
15+
<li><a href="https://github.com/CueMeet/cuemeet-teams-bot" target="_blank">Ms Teams Bot</a></li>
16+
<li><a href="https://github.com/CueMeet/cuemeet-zoom-bot" target="_blank">Zoom Meet Bot</a></li>
17+
</ul>
18+
19+
---
220

321
[![License](https://img.shields.io/badge/license-GPL%203.0-blue.svg)](LICENSE)
422
[![Docusaurus](https://img.shields.io/badge/Docusaurus-3.7.0-blue)](https://docusaurus.io/)
@@ -47,15 +65,6 @@ This will start a local development server and open up a browser window. Most ch
4765
- `npm run deploy` - Deploy the site to production
4866
- `npm run clear` - Clear the local build cache
4967

50-
### API Documentation
51-
52-
The documentation includes API reference generated from OpenAPI specifications. Use these commands to manage API docs:
53-
54-
- `npm run gen-api-docs` - Generate API documentation
55-
- `npm run clean-api-docs` - Remove generated API documentation
56-
- `npm run gen-api-docs:version` - Generate versioned API documentation
57-
- `npm run clean-api-docs:version` - Remove versioned API documentation
58-
5968
## Project Structure
6069

6170
```
@@ -67,13 +76,40 @@ documentation/
6776
└── docusaurus.config.js # Docusaurus configuration
6877
```
6978

70-
## Contributing
79+
## 📚 Documentation
80+
81+
Detailed documentation is available in the [docs](https://cuemeet.github.io/cuemeet-documentation/) directory:
82+
83+
---
84+
85+
## 🤝 Contributing
86+
87+
We welcome contributions! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for details.
88+
89+
---
90+
91+
## 🔐 Security
92+
93+
Please refer to [SECURITY.md](./SECURITY.md) for information about reporting security vulnerabilities and best practices.
94+
95+
---
96+
97+
## 🆙 Upgrading
98+
99+
For version compatibility and migration steps, see [UPGRADE.md](./UPGRADE.md).
100+
101+
---
102+
103+
## 📜 Code of Conduct
104+
105+
We follow a standard of respectful communication and collaboration. Please review our [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing.
106+
107+
---
71108

72-
When contributing to the documentation:
109+
## 📝 License
73110

74-
1. Create your working branch
75-
2. Make your changes
76-
3. Preview your changes locally using `npm start`
77-
4. Submit a pull request
111+
This project is licensed under the [GNU General Public License v3.0 (GPL-3.0)](LICENSE) — see the LICENSE file for details.
78112

79-
For more detailed information about setting up the project locally, see [local-setup.md](docs/local-setup.md).
113+
<div align="center">
114+
Made with ❤️ by CueCard.ai team
115+
</div>

SECURITY.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Security is very important to us.
6+
7+
If you have any issue regarding security, please disclose email boss@cuemeet.ai
8+
9+
We appreciate your effort to make Docs more secure.
10+
11+
## Vulnerability disclosure policy
12+
13+
Working with security issues in an open source project can be challenging, as we are required to disclose potential problems that could be exploited by attackers. With this in mind, our security fix policy is as follows:
14+
15+
1. The Maintainers team will handle the fix as usual (Pull Request,
16+
release).
17+
2. In the release notes, we will include the identification numbers from the
18+
GitHub Advisory Database (GHSA) and, if applicable, the Common Vulnerabilities
19+
and Exposures (CVE) identifier for the vulnerability.
20+
3. Once this grace period has passed, we will publish the vulnerability.
21+
22+
By adhering to this security policy, we aim to address security concerns
23+
effectively and responsibly in our open source software project.

UPGRADE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Upgrade
2+
3+
All instructions to upgrade this project from one release to the next will be
4+
documented in this file. Upgrades must be run sequentially, meaning you should
5+
not skip minor/major releases while upgrading (fix releases can be skipped).
6+
7+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
8+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
10+
## [Unreleased]
11+
12+
- AI features are now limited to users who are authenticated. Before this release, even anonymous
13+
users who gained editor access on a document with link reach used to get AI feature.
14+
IF you want anonymous users to keep access on AI features, you must now define the
15+
`AI_ALLOW_REACH_FROM` setting to "public".

0 commit comments

Comments
 (0)