From 21956a2505c5e966e5bbe7170da8478ff6948362 Mon Sep 17 00:00:00 2001 From: Ananya Srivastava Date: Mon, 16 Jun 2025 18:25:59 +0530 Subject: [PATCH 1/2] MIT License Added --- License.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 License.md diff --git a/License.md b/License.md new file mode 100644 index 0000000..b6bb447 --- /dev/null +++ b/License.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2025 Saumya813 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 139979cc33927fe7132a1ccd179ca85f73fc4a80 Mon Sep 17 00:00:00 2001 From: Ananya Srivastava Date: Mon, 16 Jun 2025 18:40:43 +0530 Subject: [PATCH 2/2] Added contribiting.md and Security.md --- Contributing.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++ Security.md | 25 ++++++++++++++ 2 files changed, 111 insertions(+) create mode 100644 Contributing.md create mode 100644 Security.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..0835258 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,86 @@ +Of course, Ananya! Here’s a structured **`CONTRIBUTING.md`** file formatted specifically for your **Notes-App** project, ready to be added: + +```markdown +# Contributing to Notes-App πŸ“’ + +Thank you for your interest in contributing to Notes-App! πŸš€ +We appreciate your efforts in improving this open-source project and making it more accessible for users. Please follow the guidelines below to ensure smooth collaboration. + +--- + +## πŸ“Œ How to Contribute + +### 1️⃣ **Fork the Repository** +- Click the **Fork** button in the top right corner of the Notes-App repository. +- This will create a personal copy in your GitHub account. + +### 2️⃣ **Clone Your Fork** +```bash +git clone https://github.com/YOUR-USERNAME/Notes-App.git +cd Notes-App +``` +Replace `YOUR-USERNAME` with your GitHub handle. + +### 3️⃣ **Create a New Branch** +Work on a separate branch to avoid conflicts: +```bash +git checkout -b feature-branch +``` +Replace `feature-branch` with a meaningful name (e.g., `fix-ui-bug`, `add-dark-mode`). + +### 4️⃣ **Make Your Changes** +- Follow coding guidelines mentioned in the repository. +- Run tests to ensure functionality. +- Add meaningful commit messages. + +### 5️⃣ **Commit & Push Your Changes** +```bash +git add . +git commit -m "Added dark mode feature" +git push origin feature-branch +``` + +### 6️⃣ **Create a Pull Request (PR)** +- Navigate to **Pull Requests** in the original repository. +- Click **New Pull Request**. +- Select your fork’s branch and submit the request. +- Provide a brief description of your changes. + +--- + +## βœ… Coding Guidelines +- Follow proper **naming conventions**. +- Maintain **clean code** with appropriate comments. +- Ensure **backward compatibility**. + +## πŸ›  Issue Reporting +- Before opening a new issue, **search for existing issues**. +- Describe the problem with **clear reproduction steps**. +- If applicable, attach **screenshots or error logs**. + +## πŸš€ Code of Conduct +By contributing, you agree to uphold a **positive, respectful environment** for all developers. + +## πŸ’¬ Need Help? +Join the **Discussions** section or contact the maintainers for support. + +--- + +Happy contributing! πŸŽ‰ +``` + +### πŸ“Œ Next Steps: +1. Copy this content and create a `CONTRIBUTING.md` file in your forked repository: + ```bash + echo "# Contributing to Notes-App" > CONTRIBUTING.md + ``` +2. Open the file and paste the full contents inside it. +3. Commit & push the changes: + ```bash + git add CONTRIBUTING.md + git commit -m "Added CONTRIBUTING.md" + git push origin feature-branch + ``` +4. Submit a Pull Request to the **main repo**! + +Since you’re actively contributing to **Notes-App (SSoC'25)**, ensure your file aligns with any existing documentation. Let me know if you need modifications! πŸš€πŸ”₯ \ No newline at end of file diff --git a/Security.md b/Security.md new file mode 100644 index 0000000..492018f --- /dev/null +++ b/Security.md @@ -0,0 +1,25 @@ +# Security Policy + +## Supported Versions +We actively maintain the following versions: +- **Latest Release** - Actively maintained +- **Previous Major Release** - Security fixes only +- **Older Versions** - No support + +## Reporting a Vulnerability +If you discover a security vulnerability, please follow these steps: +1. **Do not disclose publicly** – Contact us privately first. +2. **Contact the maintainers at** `[https://www.linkedin.com/in/soumya-srivastav-6ba783238/]` +3. Provide: + - A clear description of the issue + - Steps to reproduce the vulnerability + - Potential impact + - Recommended fix (if possible) + +## Response Timeline +- We aim to acknowledge reports within **48 hours**. +- A fix will be worked on within **7 days**, depending on severity. +- If needed, we will coordinate a responsible disclosure with you. + +## Thank You! +We appreciate responsible security researchers who help us make this project safer. πŸš€