Makedown File Update

aryasoni98 · Dec 2, 2024 · c624091 · c624091
1 parent ebe577a
commit c624091
Show file tree

Hide file tree

Showing 5 changed files with 275 additions and 238 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,108 +1,137 @@
-# Contributing to InfraBoard
+# **Contributing to InfraBoard**
 
-We are excited that you are interested in contributing to InfraBoard! This document provides guidelines for contributions to the project.
+Thank you for your interest in contributing to InfraBoard! This document provides detailed guidelines and processes to ensure your contributions align with the project's standards and workflows.
 
-## How to Contribute
+---
 
-Contributions to InfraBoard can take many forms. Here are some ways you can help:
+## **Ways to Contribute**
 
-- **Reporting Bugs**: If you find a bug, please create an issue in our issue tracker.
-- **Suggesting Enhancements**: Have ideas on how to make InfraBoard better? Open an issue with your suggestion.
-- **Code Contributions**: If you want to write code for InfraBoard, that's great! Start by looking at our open issues.
+- **Report Bugs**: Identify issues and create detailed reports in our [Issue Tracker](https://github.com/xerocodee/InfraBoard/issues).
+- **Suggest Enhancements**: Share ideas to improve InfraBoard by opening a discussion or issue.
+- **Code Contributions**: Tackle open issues or suggest new features to enhance InfraBoard's functionality.
 
-## Steps for Contributing
+---
 
-1. **Fork the Repository**: Start by forking the InfraBoard repository to your GitHub account.
+## **Contribution Workflow**
 
-2. **Clone the Forked Repository**: Clone your fork to your local machine.
+### **Steps for Contributing**
 
-3. **Create a New Branch**: Create a branch for your contribution (`git checkout -b feature/YourFeature`).
+1. **Fork the Repository**: Fork InfraBoard's repository to your GitHub account.
+2. **Clone Your Fork**: Clone the forked repository locally:
+   ```bash
+   git clone https://github.com/<your-username>/InfraBoard.git
+   ```
+3. **Create a New Branch**: Use a feature-specific branch name:
+   ```bash
+   git checkout -b feature/YourFeature
+   ```
+4. **Make Changes**: Implement your feature or bug fix in the appropriate files.
+5. **Test Your Changes**: Ensure your changes pass existing tests and add new ones if necessary.
+6. **Commit Changes**: Write clear, descriptive commit messages:
+   ```bash
+   git commit -m "Add YourFeature"
+   ```
+7. **Push Changes**: Push your branch to your fork:
+   ```bash
+   git push origin feature/YourFeature
+   ```
+8. **Open a Pull Request**: Create a pull request (PR) to merge your branch into InfraBoard's `test` branch.
 
-4. **Make Your Changes**: Work on the changes you wish to make.
+---
 
-5. **Test Your Changes**: Ensure your changes do not introduce any new bugs or issues.
+## **GitHub Desktop Workflow**
 
-6. **Commit Your Changes**: Commit your changes with a clear commit message (`git commit -m 'Add YourFeature'`).
+1. **Open GitHub Desktop**:
+   - Log in to your GitHub account.
+2. **Clone Repository**:
+   - Clone InfraBoard's repository via the "Clone Repository" option.
+3. **Switch to a New Branch**:
+   - Use the "Current Branch" dropdown to create or switch branches.
+4. **Make Changes**:
+   - Edit files locally using your preferred editor.
+5. **Commit Changes**:
+   - Use GitHub Desktop to stage and commit your changes.
+6. **Push Changes**:
+   - Push your branch to your forked repository.
+7. **Create a Pull Request**:
+   - Use the "Compare & Pull Request" button on GitHub to open a PR.
 
-7. **Push to Your Branch**: Push your changes to your branch (`git push origin feature/YourFeature`).
+---
 
-8. **Open a Pull Request**: Go to the InfraBoard repository and open a pull request from your branch.
+## **Branching and PR Strategy**
 
-## Alternatively, contribute using GitHub Desktop
+All new features or bug fixes should be made on a separate feature or bug branch. Submit pull requests to the `test` branch for review and testing before merging into the main or stage branch.
 
-1. **Open GitHub Desktop:**
-
-   Launch GitHub Desktop and log in to your GitHub account if you haven't already.
+```mermaid
+graph TD
+  A[feature/bug branch] --> B[test branch]
+  B --> C[stage branch]
+  C --> D[master branch]
+```
 
-3. **Clone the Repository:**
-
-   - If you haven't cloned the InfraBoard repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
-   - Choose the InfraBoard repository from the list of repositories on GitHub and clone it to your local machine.
+---
 
-5. **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.
+## **Coding Guidelines**
 
-7. **Make Changes:**
-   
-   Make your changes to the code or files in the repository using your preferred code editor.
+- Follow the project's coding standards (see `.eslintrc.json` and `.prettierrc`).
+- Ensure your code is clean, readable, and maintainable.
+- Comment your code where necessary to improve clarity.
 
-9. **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 <branch-name>" button to commit your changes to the local branch.
+---
 
-11. **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.
+## **Documentation Guidelines**
 
-13. **Create a Pull Request:**
-
-  - Go to the GitHub website and navigate to your fork of the InfraBoard repository.
-  - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
+If your changes require documentation updates:
+- Include documentation updates in your pull request.
+- Ensure clarity and consistency in writing.
 
-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.
+---
 
-10. **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 InfraBoard repository.
+## **Pull Request Guidelines**
 
-⭐️ Support the Project
-If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.
+- Keep PRs concise and focused on a single feature or fix.
+- Provide a clear and detailed description of the changes.
+- Reference relevant issue numbers for context.
 
-## Notes :
+---
 
-To contribute to InfraBoard, always push new features or bug fixes to a feature/bug branch first. Then, raise a pull request (PR) from your feature/bug branch to the test branch for review. It's crucial to target the test branch with your PRs to ensure changes are tested before merging into the master/stage codebase. This approach helps maintain the stability and quality of the project.
+## **Code of Conduct**
 
-## Coding Guidelines
+By contributing to InfraBoard, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). It ensures a welcoming and inclusive environment for all contributors.
 
-- Ensure your code adheres to the project's coding standards.
-- Write clean, readable, and maintainable code.
-- Include comments in your code where necessary.
+---
 
-## Documentation
+## **Communication Channels**
 
-If you are adding new features or making changes that require documentation updates, please include them in your pull requests.
+If you have questions or need assistance:
+- [Discord](https://discord.gg/nmRb3fsTgu)
+- [Discussions Room](https://github.com/xerocodee/InfraBoard/discussions)
 
-## Pull Request Guidelines
+---
 
-- Keep pull requests concise and focused on a single issue or feature.
-- Provide a detailed description of your changes in the pull request.
-- Reference any relevant issue numbers in your pull request description.
+## **Support the Project**
 
-## Code of Conduct
+If you find InfraBoard helpful, consider giving it a ⭐️ on GitHub. Your support helps us grow and reach more contributors.
 
-Please note that this project is released with a Contributor [Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+---
 
-## Questions?
+## **Mermaid Diagram: Contribution Workflow**
 
-If you have any questions or need assistance, feel free to open an issue for discussion.
+```mermaid
+graph TD
+  A[Contributor Forks Repository] --> B[Clone Repository Locally]
+  B --> C[Create a New Branch]
+  C --> D[Make Changes]
+  D --> E[Test Changes]
+  E --> F[Commit Changes]
+  F --> G[Push to Fork]
+  G --> H[Open Pull Request]
+  H --> I[Review by Maintainers]
+  I --> J[Merge into Test Branch]
+  J --> K[Merge into Stage Branch]
+  K --> L[Merge into Master Branch]
+```
 
-- [Discord](https://discord.gg/nmRb3fsTgu)
-- [Discussions Room](https://github.com/xerocodee/InfraBoard/discussions)
+---
 
-Thank you for contributing to InfraBoard, and we look forward to your contributions!
+Thank you for contributing to InfraBoard! Your contributions make a significant impact on the project's success.
diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md