Skip to content

Latest commit

 

History

History
121 lines (84 loc) · 5.26 KB

CONTRIBUTING.md

File metadata and controls

121 lines (84 loc) · 5.26 KB
Raw

Contributing to NoDueProject 🚀

Thank you for your interest in contributing to this NoDueProject! We appreciate all contributions, whether they're bug fixes, new features, documentation improvements, or any other enhancements. 🌟

Please follow the guidelines below to ensure a smooth contribution process.

Getting Started 🛠️

To work confidently with our codebase, please review the introduction to working in the docs repository. If you're new to writing markdown files, you can refer to the GitHub Markdown reference for guidance.

Before making any changes, please check the types of contributions we accept. You might be surprised to find that some contributions don't require writing a single line of code! 💡

1. Identify an Issue 🔍

  • Create a New Issue or Find Existing Ones

    If you come across any problems or issues with the documentation, first search our existing issues to check if a related one already exists. If not, you can open a new issue using the relevant issue form. 📝

  • Solve an Issue

    Browse through our existing issues and filter them using labels to find one that interests you. As a general practice, we don't assign issues to specific individuals. If you find an issue you'd like to work on, feel free to open a pull request with your proposed fix. 💪

Issue Template:

  • Issue Title: A concise and descriptive title.
  • Description: Clear and detailed description of the issue or feature request.
  • Steps to Reproduce: Detailed steps to reproduce the issue.
  • Expected Behavior: What you expected to happen.
  • Screenshots: If applicable, add screenshots to help explain your problem.

2. Making Changes ✏️

Make Changes in the UI

  • For small changes like fixing a typo, correcting a sentence, or updating a broken link, navigate to any docs page and click on "Make a contribution" at the bottom. This will take you to the .md file where you can make your changes and create a pull request for review. 🖊️

Make Changes in a Codespace

Make Changes Locally

To make changes locally, follow these steps:

Step 1: Fork the Repository 🍴

Once you have identified the issue or feature you want to work on:

  1. Fork this repository to your GitHub account by clicking the "Fork" button in the top right.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/YOUR-USERNAME/NoDueProject.git

  3. Navigate to the project directory:

    cd NoDueProject

    Further, you can Navigate to the project directory(Frontend):

    cd client

    or Navigate to the project directory(Backend):

    cd server

Step 2: Create a New Branch 🌳

Before making changes, create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

Step 3: Make the Necessary Changes ⚙️

Work on your branch to make the required changes. Ensure that your code follows these guidelines:

  • Code Quality: Maintain clean, modular, and efficient code. Comment your code where necessary.
  • Structure: Follow the existing folder and component structure to keep things consistent.
  • Testing: Test your code thoroughly to ensure there are no bugs or issues.
  • Screenshots or Videos: Take screenshots or record a short video of your changes to demonstrate what you worked on.

Step 4: Commit and Push Your Changes 📦

Once your changes are complete, add your changes to the staging area:

git add .

Once your changes are complete, commit them with a clear and concise message:

git commit -m "Add feature/your-feature-name"

Push the changes to your forked repository:

git push origin feature/your-feature-name

Step 5: Create a Pull Request (PR) 🔄

Go to the original repository and click "Compare & Pull Request".

Pull Request 📨

When you've completed your changes, create a pull request (PR) using the following steps:

  1. Fill out the "Ready for review" template in the PR so that we can review your changes effectively. If you're solving an issue, don't forget to link the PR to the relevant issue.
  2. Enable the checkbox to allow maintainer edits so that the branch can be updated for a merge.
  3. Submit your PR, and a member of the Docs team will review your proposal. They may ask questions or request additional information.
  4. As you update your PR and apply changes, mark each conversation as resolved.
  5. If you encounter any merge issues, refer to a git tutorial to help resolve conflicts and other problems.
  6. Once your PR is merged, congratulations!🎉 Your contributions will be publicly visible on the GitHub docs.

Thank You for Contributing! 🙏

We greatly appreciate your contributions to NoDueProject. If you have any doubts or need clarification at any point, please feel free to reach out by creating an issue or asking a question in the PR comments.

Happy coding!

This document ensures that contributors understand how to get started, work within the 's guidelines, and maintain quality contributions.