Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 3.55 KB
Raw

Contributing Guidelines 🤝🚀

Thank you for considering contributing to CogniGuard! We welcome your help in making this project even better.

Here are the key points to guide your contributions:

  • Fork the Repository: Start by forking the CogniGuard repository to your own GitHub account. 🍴

  • Clone the Repository: Clone the forked repository to your local machine using . 💻

git clone https://github.com/4darsh-Dev/CogniGaurd

  • Create a Branch: Create a branch for your contributions using a descriptive branch name. 🌿

  • Make Changes: Implement your changes or additions, ensuring they align with the project's goals. 🚀

  • Testing: Test your changes thoroughly to ensure functionality and prevent regressions. ✔️

  • Commit Changes: Commit your changes with clear, concise messages. 💬

  • Create Pull Request: Push your changes to your forked repository and create a Pull Request (PR) to the main CogniGuard repository. 🎉

  • Follow Code Standards: Adhere to coding standards and guidelines defined in the project. 📋

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 CogniGaurd repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • 🌐 Choose the CogniGaurd 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 CogniGaurd repository.
  • 🔄 You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. 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.

  2. 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 CogniGaurd repository.

  • Provide Detailed PR Description: Clearly explain the purpose and impact of your PR. 📝

  • Participate in Discussions: Engage in discussions related to your PR and address feedback promptly. 💬

By following these guidelines, you contribute to the growth and improvement of CogniGuard. Thank you for your valuable contributions! 🚀