[docs]: Update SECURITY.md and CONTRIBUTING.md with contribution guidelines and security reporting instructions

codad5 · codad5 · commit f2923f790f50 · 2024-10-11T06:36:25.000+01:00
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,79 +1,38 @@
-# Code of Conduct
+# Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-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, religion, or sexual identity and orientation.
+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, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We are committed to providing a friendly, safe, and welcoming environment for all.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to creating a positive environment include:
 
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall community
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Showing empathy towards other community members
+- Demonstrating tolerance and politeness
 
 Examples of unacceptable behavior include:
 
-- The use of sexualized language or imagery, and sexual attention or advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others’ private information, such as a physical or email address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a professional setting
+- Harsh language, insults, or personal attacks
+- Discriminatory jokes or comments
+- Threatening, violent, or intimidating behavior
+- Scamming, misleading, or intentionally deceiving contributors or users
+- Disrespectful or unprofessional interactions
+- Doxxing (publishing private information) or inappropriate sharing of personal information
 
 ## Enforcement Responsibilities
 
-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.
-
-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.
-
-## Scope
-
-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.
+Project maintainers are responsible for clarifying the standards of acceptable behavior and will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [hello@codad5.me] or [aniezeoformic@gmail.com]. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**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
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**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
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**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
-
-**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.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported via GitHub issues. The maintainers will review and investigate all complaints and will respond appropriately to maintain a healthy community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-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.
-
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,87 +1,66 @@
+# Contributing to QuickCv
 
-# Contribution Guidelines
-
-Thank you for considering contributing to **QuickCV**! Your help is greatly appreciated. This document provides guidelines for contributing to the project.
-
-## Table of Contents
-
-1. [Getting Started](#getting-started)
-2. [How to Contribute](#how-to-contribute)
-3. [Coding Guidelines](#coding-guidelines)
-4. [Commit Messages](#commit-messages)
-5. [Pull Request Process](#pull-request-process)
-6. [Code of Conduct](#code-of-conduct)
-
-## Getting Started
-
-1. **Fork the repository**: Fork the [QuickCV repository](https://github.com/codad5/quickcv) to your GitHub account.
-2. **Clone your fork**: Clone the forked repository to your local machine.
-   ```sh
-   git clone https://github.com/<your-username>/quickcv.git
-   cd quickcv
-   ```
-3. **Install dependencies**: Install the necessary dependencies using npm or yarn.
-   ```sh
-   npm install
-   # or
-   yarn install
-   ```
-4. **Start the development server**: Run the development server to ensure everything is set up correctly.
-   ```sh
-   npm run dev
-   # or
-   yarn dev
-   ```
+Thank you for considering contributing to QuickCv! We appreciate your help in making this project better. Below are the guidelines for contributing to this project.
 
 ## How to Contribute
 
-1. **Report Bugs**: If you find a bug, please create an issue with detailed information about the bug and how to reproduce it.
-2. **Suggest Features**: If you have an idea for a new feature, please create an issue or open a discussion to discuss your idea.
-3. **Code Contributions**: If you want to contribute code, please follow the steps below.
-
-## Coding Guidelines
-
-1. **Code Style**: Follow the coding style of the existing codebase. Use ESLint and Prettier to ensure consistent code formatting.
-2. **Components**: Break down your code into reusable components. Organize and store them properly.
-3. **Typescript**: Use TypeScript for type safety and to improve code quality.
-4. **CSS**: If not using CSS frameworks like Tailwind, keep class names concise and use CSS variables for easy maintenance.
-
-## Commit Messages
-
-Write brief yet descriptive commit messages. Use the format:
-
-```
-[<change-type>: <message>]
-```
-
-Examples of `<change-type>` include but are not limited to:
-
-- `bug-fix`: Fixes a bug
-- `feat`: Adds a new feature
-- `revision`: Refactors existing code
-- `improvement`: Improves existing functionality
-
-## Pull Request Process
-
-1. **Create a Branch**: Create a new branch for your work.
-   ```sh
-   git checkout -b feature/my-feature
-   ```
-2. **Commit Changes**: Commit your changes with clear and descriptive commit messages.
-3. **Push to GitHub**: Push your changes to your forked repository.
-   ```sh
-   git push origin feature/my-feature
-   ```
-4. **Create a Pull Request**: Open a pull request to the `main` branch of the original repository. Provide a clear description of your changes and link to any relevant issues.
-
-## Code of Conduct
-
-Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to adhere to it.
-
----
-
-Thank you for your contributions! Together, we can make **QuickCV** an even better project.
-
-Best regards,  
-Chibueze Aniezeofor ([@codad5](https://github.com/codad5))
-
+1. **Fork the repository**
+   - Fork the QuickCv repository to your GitHub account.
+
+2. **Clone your forked repository**
+   - Clone the repository to your local machine:
+     ```bash
+     git clone https://github.com/codad5/quickcv.git
+     ```
+
+3. **Create a new branch for your changes**
+   - Name your branch descriptively (e.g., `fix-validation-error`, `add-new-feature`):
+     ```bash
+     git checkout -b your-branch-name
+     ```
+
+4. **Make your changes**
+   - Ensure that your changes are well-structured and follow the coding standards of the project.
+
+5. **Commit your changes**
+   - Write clear, meaningful commit messages in the following format:
+     ```bash
+     [change-type]: your message
+     ```
+     Example:
+     ```bash
+     [feat]: added certificate field in the resume generator
+     ```
+     - **Change types**:
+       - `feat` : For new features
+       - `fix` : For bug fixes
+       - `docs` : For documentation updates
+       - `style` : For formatting changes
+       - `refactor` : Code changes that neither fix a bug nor add a feature
+       - `test` : Adding or updating tests
+       - `chore` : Maintenance tasks, such as updating dependencies
+
+6. **Push to your forked repository**
+   - Push your changes:
+     ```bash
+     git push origin your-branch-name
+     ```
+
+7. **Submit a pull request**
+   - Open a pull request from your forked repository to the main repository.
+
+8. **Wait for a review**
+   - We will review your pull request and may request changes. Please be patient as we get to your submission.
+
+## Reporting Issues
+
+- If you find any bugs or have feature requests, please open an issue on GitHub.
+- Make sure the issue hasn't already been reported by searching through existing issues.
+
+## Coding Standards
+
+- Follow the existing style of the codebase.
+- Use meaningful variable and function names.
+- Keep the code clean and organized.
+
+Thank you for contributing!
diff --git a/SECURITY.md b/SECURITY.md
@@ -2,20 +2,21 @@
 
 ## Supported Versions
 
-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+We take security seriously and will address any issues as soon as possible. If you encounter any vulnerabilities in the project, please report them to us.
 
-| Version | Supported          |
-| ------- | ------------------ |
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                |
+| Version        | Supported          |
+| -------------- | ------------------ |
+| Latest Release | :white_check_mark:  |
+| Older Versions | :x:                |
 
 ## Reporting a Vulnerability
 
-Use this section to tell people how to report a vulnerability.
+To report a security vulnerability, please follow these steps:
 
-Tell them where to go, how often they can expect to get an update on a
-reported vulnerability, what to expect if the vulnerability is accepted or
-declined, etc.
+1. Open a new issue on the [GitHub Issues](https://github.com/codad5/quickcv/issues) page.
+2. Clearly describe the vulnerability and how it can be reproduced.
+3. We will acknowledge the issue and work on a resolution as soon as possible.
+
+Please do **not** submit security vulnerabilities as public pull requests or public comments until the issue has been addressed.
+
+Thank you for helping keep QuickCv secure!
