Skip to content

Latest commit

 

History

History
200 lines (134 loc) · 7.02 KB

CONTRIBUTING.md

File metadata and controls

200 lines (134 loc) · 7.02 KB
Raw

Contributing Guidelines

Thank you for taking the time to contribute to the project. Please take a moment to read the following guidelines before contributing:

Important points to keep in mind before starting ✅

  • If anything is missing or if you find something that needs to be enhanced/fixed/modified in the project, please feel free to create an issue.
  • Ask to get the issue assigned to you before working on the issue & making a PR.
  • Don't create a PR until the issue is not assigned to you.
  • Mention the issue number in the PRs and describe all the changes that you have made briefly in the PR(if possible attach a screen recording showing the changes you made).

How to Contribute? 🤔

Step 1: Fork the Repository

Click on the Fork button.

By forking the repository, you will have your repository version under your GitHub username.

Once you have forked your repository, go to your profile inside the repository section, and you will find your forked repository.

Step 2: Clone the Forked Repository

Once you locate your repository, you must clone it to your local machine.

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

Congratulations! You have successfully cloned the repository to your local machine. You can now make changes, add new features, or fix issues in the codebase.

Step 3: Go to the client directory

cd Mindfulness/client

Step 4: Install all the dependencies

npm install

Step 5: Edit the ".env" file with required configurations

VITE_AUTH0_DOMAIN="AUTH0_DOMAIN"
VITE_AUTH0_CLIENT_ID="AUTH0_CLIENT_ID"
VITE_AUTH0_REDIRECT_URL="AUTH0_REDIRECT_URL"
VITE_OPENAI_API_KEY="OPENAI_API_KEY"

Step 6: Start the frontend application

npm run dev

NOTE: Proceed with steps 7-9 only if there is a need for backend interaction

Step 7: Go to the server directory

cd Mindfulness/server

Step 8: Create and source a virtual environment:

python -m venv venv
source venv/bin/activate

Step 8: Install the required modules

pip install -r requirements.txt

Step 9: Run the backend application

python manage.py runserver

Open http://localhost:5173 with your browser to see the result.

Step 10: Create a New Branch (important)

It's recommended to create a new branch for your changes. This helps keep your modifications separate from the main branch, making it easier to manage and review your contributions.

git checkout -b <branch-name>

Step 11: Make Your Changes

Make the necessary changes or additions to the codebase. Once you have added changes in your local, it's time to push them, for that run this command to bring the modification to the staging area.

Step 12: Check your changes

git status

git diff

git status: Shows the current status of the repository, including changes, untracked files, and branch information.

git diff: Displays the differences between the working directory and the last commit or between branches.

Step 13: Stage your changes

git add .

This command is used to stage all the changes in the current directory and it's subdirectories for the next commit. It adds all modified and new files to the staging area, allowing you to include them in the next commit.

Note: The . represents the current directory, so git add . includes all files and directories within the current working directory. This means if you are anywhere outside from the directory then the changes would not be staged. So make sure you are in correct directory.

Step 14: Commit Your Changes

Commit your changes with a meaningful commit message using the following command:

  git commit -m "Enter Your message related to what work you did"

(make sure to add a decent commit message to avoid confusion and get your PR merged)

Once you have committed your changes, it's time to push them to your forked repository on GitHub.

Step 15: Push Your Changes

Use the following command to push your changes:

git push -u origin <branch-name>

Replace with the name of the branch you created earlier.

Step 16: Make a Pull Request

After pushing your changes, open your forked repository on GitHub in your web browser.

Click on compare and pull request

Provide a clear and informative title and description for your pull request. Explain the changes you have made and why they should be incorporated into the original repository.

Review your pull request to ensure everything is correct, and then click on the "Create pull request" button to submit it.

Congratulations! 🎉

Your pull request will now be visible to the maintainers of the original repository. They will review your changes, provide feedback if necessary, and decide whether to merge them into the main branch.

Congratulations! You have successfully created a pull request to contribute your changes to the repository. Remember to monitor the pull request for any updates or feedback from the maintainers.

Commit Message Guidelines using Commitlint

We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines:

  1. Type: The commit type must be one of the following:

    • feat: A new feature or enhancement.
    • fix: A bug fix.
    • docs: Documentation changes.
    • style: Code style changes (e.g., formatting, semicolons).
    • refactor: Code refactorings with no feature changes or bug fixes.
    • test: Adding or improving tests.
    • chore: General maintenance tasks, build changes, etc.

  2. Scope (Optional): The scope provides context for the commit, indicating the specific part of the project being affected. Use a short description in lowercase (e.g., auth, navbar, README).

  3. Description: A brief and meaningful description of the changes made. Start with a capital letter and use the imperative mood (e.g., "Add new feature" instead of "Added new feature").

  4. Issue reference (Optional): Include the issue number associated with the commit (e.g., #123).

Examples:

Valid Commit Messages:

  • feat: Add user authentication feature
  • fix(auth): Resolve login page redirect issue
  • docs: Update installation instructions
  • style: Format code according to project guidelines
  • refactor(navbar): Improve responsiveness
  • test: Add unit tests for API endpoints
  • chore: Update dependencies to latest versions
  • fix: Handle edge case in data processing (#456)

Invalid Commit Messages:

  • Added new stuff
  • Fixed a bug
  • Updated code
  • auth feature update
  • chore: fixed some stuff

By following these guidelines, we can maintain a clean commit history that is easy to understand and helps us effectively track changes. If you have any questions or need further assistance, feel free to ask! Happy contributing!

Don't forget to give a ⭐ to this repo !!