From 033c6c8d429b2492e2f9632ac71c435bf5ba144f Mon Sep 17 00:00:00 2001 From: a-n-u-vanguri Date: Wed, 23 Oct 2024 12:29:03 +0530 Subject: [PATCH 1/3] Documentation: UPDATE Of Contributing.md #84 --- CONTRIBUTORS.md | 271 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 228 insertions(+), 43 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 0504982..19cbe07 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,65 +1,250 @@ - # Welcome to Slanine! -We're excited to have you contribute to our project. This guide will help you get started with contributing to **Slanine**. +Welcome to our project! We're thrilled to have you contribute. Your efforts, big or small, make a difference. Please ensure that you follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. + +
+ +# Need Help with the Basics? πŸ€” + +If you're new to Git and GitHub, no worries! Here are some useful resources: + +- [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) +- [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) +- [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) +- [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) +- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) + +
+ +# Project Structure πŸ“‚ + +```bash + +Slanine/ +β”œβ”€β”€ .github/ # Configuration files for GitHub, including workflows +β”‚ β”œβ”€β”€ workflow/ # Workflow configurations +β”‚ β”‚ β”œβ”€β”€ issue_closed_opened.yml +β”‚ β”‚ β”œβ”€β”€ issue_labeler.yaml +β”‚ β”‚ β”œβ”€β”€ pr-checker.yaml +β”‚ β”‚ β”œβ”€β”€ pr_merged.yaml +β”‚ β”‚ └── pr_raise.yml +β”œβ”€β”€ app/ # Main application code +β”‚ β”œβ”€β”€ (auth)/ # Authentication related routes +β”‚ β”‚ β”œβ”€β”€ sign-in/[[...sign-in]] +β”‚ β”‚ └── sign-up/[[...sign-up]] +β”‚ β”œβ”€β”€ (context)/ # Context providers +β”‚ β”‚ └── TotalUsageContext.tsx +β”‚ β”œβ”€β”€ (data)/ # Data handling components +β”‚ β”‚ └── Templates.tsx +β”‚ β”œβ”€β”€ api/ # API routes +β”‚ β”‚ └── subscribe +β”‚ β”‚ └── route.ts +β”‚ β”œβ”€β”€ billing/ # Billing components +β”‚ β”‚ β”œβ”€β”€ layout.tsx +β”‚ β”‚ └── page.tsx +β”‚ β”œβ”€β”€ dashboard/ # Dashboard components +β”‚ β”‚ β”œβ”€β”€ _components +β”‚ β”œβ”€β”€ settings/[[...settings]] # Settings routes +β”‚ β”‚ β”œβ”€β”€ layout.tsx +β”‚ β”‚ └── page.tsx +β”‚ β”œβ”€β”€ favicon.ico # Favicon +β”‚ β”œβ”€β”€ globals.css # Global styles +β”‚ β”œβ”€β”€ layout.tsx # Main layout component +β”‚ β”œβ”€β”€ not-found.tsx # 404 page +β”‚ └── page.tsx # Main page component +β”œβ”€β”€ components/ # Reusable UI components +β”‚ β”œβ”€β”€ magicui # Animated UI components +β”‚ β”‚ β”œβ”€β”€ animated-shiny-text.tsx +β”‚ β”‚ β”œβ”€β”€ magic-card.tsx +β”‚ β”‚ └── marquee.tsx +β”‚ β”œβ”€β”€ ui # General UI components +β”‚ β”‚ β”œβ”€β”€ BentoGrid.tsx +β”‚ β”‚ β”œβ”€β”€ FloatingNavbar.tsx +β”‚ β”‚ └── ... # Other UI components +β”‚ └── ... # Other components +β”œβ”€β”€ lib/ # Libraries and utilities +β”‚ β”œβ”€β”€ ratelimit.ts +β”‚ └── utils.ts +β”œβ”€β”€ public/ # Public assets +β”‚ β”œβ”€β”€ img11.svg +β”‚ β”œβ”€β”€ logo.svg +β”‚ β”œβ”€β”€ next.svg +β”‚ β”œβ”€β”€ robots.txt +β”‚ └── vercel.svg +β”œβ”€β”€ utils/ # Utility functions +β”‚ β”œβ”€β”€ AIModal.tsx +β”‚ β”œβ”€β”€ cn.ts +β”‚ β”œβ”€β”€ db.tsx +β”‚ └── schema.tsx +β”œβ”€β”€ .dockerignore # Docker ignore file +β”œβ”€β”€ .gitignore # Git ignore file for untracked files +β”œβ”€β”€ CODE_OF_CONDUCT.md # Code of conduct for contributors +β”œβ”€β”€ CONTRIBUTORS.md # List of contributors to the project +β”œβ”€β”€ Dockerfile # Docker configuration for the project +β”œβ”€β”€ LICENSE # License file for the project +β”œβ”€β”€ README.md # Main README file with project details +β”œβ”€β”€ components.json # Component configuration file +β”œβ”€β”€ docker-compose.yml # Docker Compose configuration +β”œβ”€β”€ drizzle.config.js # Drizzle configuration file +β”œβ”€β”€ middleware.ts # Middleware features +β”œβ”€β”€ next-sitemap.config.js # Sitemap configuration +β”œβ”€β”€ next.config.mjs # Next.js configuration +β”œβ”€β”€ package-lock.json # Lock file for dependencies +β”œβ”€β”€ package.json # Project dependencies and scripts +β”œβ”€β”€ postcss.config.mjs # PostCSS configuration +β”œβ”€β”€ tailwind.config.ts # Tailwind CSS configuration +└── tsconfig.json # TypeScript configuration + +``` + +# First Pull Request ✨ + +1. **Star this repository** + Click on the top right corner marked as **Stars** at last. + +2. **Fork this repository** + Click on the top right corner marked as **Fork** at second last. Slanine + +3. **Clone the forked repository** + +```bash +git clone https://github.com//Slanine.git +``` + +4. **Navigate to the project directory** + +```bash +cd Slanine +``` + +5. **Create a new branch** + +```bash +git checkout -b +``` + +6. **To make changes** + +```bash +git add . +``` + +7. **Now to commit** + +```bash +git commit -m "add comment according to your changes or addition of features inside this" +``` + +8. **Push your local commits to the remote repository** + +```bash +git push -u origin +``` + +9. **Create a Pull Request** + +10. **Congratulations! πŸŽ‰ you've made your contribution** + +
+ +# Alternatively contribute using GitHub Desktop πŸ–₯️ + +1. **Open GitHub Desktop:** + Launch GitHub Desktop and log in to your GitHub account if you haven't already. + +2. **Clone the Repository:** + - If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository." + - Choose the repository from the list of repositories on GitHub and clone it to your local machine. + +3. **Switch to the Correct Branch:** + - Ensure you are on the branch that you want to submit a pull request for. + - If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch. + +4. **Make Changes:** + Make your changes to the code or files in the repository using your preferred code editor. + +5. **Commit Changes:** + - In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit. + - Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch. + +6. **Push Changes to GitHub:** + After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub. + +7. **Create a Pull Request:** + - Go to the GitHub website and navigate to your fork of the repository. + - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it. + +8. **Review and Submit:** + - On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request. + - Once you're satisfied, click the "Create pull request" button to submit your pull request. + +9. **Wait for Review:** + Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository. + +
+ + +# Good Coding Practices πŸ§‘β€πŸ’» + +1. **Follow the Project's Code Style** + + - Maintain consistency with the existing code style (indentation, spacing, comments). + - Use meaningful and descriptive names for variables, functions, and classes. + - Keep functions short and focused on a single task. + - Avoid hardcoding values; instead, use constants or configuration files when possible. + +2. **Write Clear and Concise Comments** -## Getting Started + - Use comments to explain why you did something, not just what you did. + - Avoid unnecessary comments that state the obvious. + - Document complex logic and functions with brief explanations to help others understand your thought -process. -1. **Fork the repository** - Click the "Fork" button at the top right corner of this page to create a copy of the repository in your own GitHub account. +3. **Keep Code DRY (Don't Repeat Yourself)** -2. **Clone the repository** - Run the following command to download the repository to your local machine: - ```bash - git clone https://github.com/your-username/slanine.git - ``` + - Avoid duplicating code. Reuse functions, methods, and components whenever possible. + - If you find yourself copying and pasting code, consider creating a new function or component. -3. **Install dependencies** - Navigate to the project directory and run the following command to install the required dependencies: - ```bash - npm install - ``` +4. **Write Tests** -## Contributing + - Write unit tests for your functions and components. + - Ensure your tests cover both expected outcomes and edge cases. + - Run tests locally before making a pull request to make sure your changes don’t introduce new bugs. -1. **Choose an issue/report Issue** - Browse through our [issues tab](https://github.com/Rakshit-gen/Slanine/issues) and choose an issue that you'd like to work on.If you spot a problem while reviewing the project, feel free to open a new issue and wait for us to assign it to you. (Please avoid creating duplicates if the issue already exists in the tab.) +5. **Code Reviews and Feedback** -2. **Create a branch** - Run the following command to create a new branch for your feature: - ```bash - git checkout -b - ``` + - Be open to receiving constructive feedback from other contributors. + - Conduct code reviews for others and provide meaningful suggestions to improve the code. + - Always refactor your code based on feedback to meet the project's standards. -3. **Make changes** - Make the necessary changes to the code and commit them with a descriptive commit message. +
-4. **Push changes** - Run the following command to push your changes to your fork: - ```bash - git push origin - ``` +# Pull Request Process πŸš€ -5. **Create a pull request** - Go to the Slanine repository and click the "New pull request" button. Select your branch and fill in the pull request form. +When submitting a pull request, please adhere to the following: -## Pull Request Guidelines +1. **Self-review your code** before submission. +2. Include a detailed description of the functionality you’ve added or modified. +3. Comment your code, especially in complex sections, to aid understanding. +4. Add relevant screenshots to assist in the review process. +5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! πŸš€ -1. **Use a descriptive title** - Use a descriptive title for your pull request that summarizes the changes you've made. +
-2. **Include a description** - Include a brief description of the changes you've made and why they're necessary. +# Issue Report Process πŸ“Œ -3. **Use proper formatting** - Use proper formatting for your code and commit messages. +To report an issue, follow these steps: -## Code of Conduct +1. Navigate to the project's issues section :- [Issues](https://github.com/Rakshit-gen/Slanine/issues) +2. Provide a clear and concise description of the issue. +3. **Avoid spamming** to claim an issue. Patience is key! +4. Wait until someone looks into your report. +5. Begin working on the issue only after you have been assigned to it. πŸš€ -We follow the [Slanine Code of Conduct](https://github.com/Rakshit-gen/Slanine/blob/main/CODE_OF_CONDUCT.md). Please make sure to read and follow it. +
+# Thank you for contributing πŸ’— +We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! πŸš€ -## Thank You! +## -Thank you for contributing to **Slanine**! We appreciate your help in making our project better. From a67664b86173afc54d5c89f294bb8f02112bd1cb Mon Sep 17 00:00:00 2001 From: a-n-u-vanguri Date: Wed, 23 Oct 2024 12:56:57 +0530 Subject: [PATCH 2/3] Documentation: UPDATE Of Contributing.md #84 --- CONTRIBUTORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 19cbe07..b4aab11 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -103,7 +103,7 @@ Slanine/ Click on the top right corner marked as **Stars** at last. 2. **Fork this repository** - Click on the top right corner marked as **Fork** at second last. Slanine + Click on the top right corner marked as **Fork** at second last. 3. **Clone the forked repository** From c4f96d53c1f9d6f41192b4c8c266b6badb613761 Mon Sep 17 00:00:00 2001 From: a-n-u-vanguri Date: Wed, 23 Oct 2024 14:50:28 +0530 Subject: [PATCH 3/3] Update CONTRIBUTORS.md --- CONTRIBUTORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index b4aab11..71b319d 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -236,7 +236,7 @@ To report an issue, follow these steps: 1. Navigate to the project's issues section :- [Issues](https://github.com/Rakshit-gen/Slanine/issues) 2. Provide a clear and concise description of the issue. -3. **Avoid spamming** to claim an issue. Patience is key! +3. **Avoid spamming** to claim an issue. Patience is key! πŸ˜ƒ 4. Wait until someone looks into your report. 5. Begin working on the issue only after you have been assigned to it. πŸš€