Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

94 lines (71 loc) · 3.22 KB
Raw

Contributing Guidelines

Welcome to the project! We appreciate your interest and contributions. Before getting started, please take a moment to review the following guidelines.

Table of Contents

  • How Can You Contribute

  • Code Contribution

  • Bug Reports

  • Feature Requests

  • Community Guidelines

  • License

How Can You Contribute

There are several ways you can contribute to this project:

  • Reporting bugs and issues
  • Requesting new features
  • Fixing bugs and implementing new features
  • through pull requests
  • Improving documentation
  • Providing feedback and suggestions

Code Contribution

If you would like to contribute code to the project, please follow these steps:

  • Step 1: Fork the repo first

  • Step 2: Go to your Git terminal and clone it on your machine.

    git clone https://github.com/<your_github_username>/UMatter.git

  • Step 3: Add an upstream link to the main branch in your cloned repo

    git remote add upstream https://github.com/MonalikaPatnaik/UMatter.git

  • Step 4: Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

    git pull upstream main

  • Step 5: Create your feature branch (This is a necessary step, so don't skip it)

    git checkout -b <feature-name>

  • Step 6: Track and stage your changes.

     # Track the changes
 git status

 # Add changes to Index
 git add . or git add <file_name>

  • Step 7: Commit your changes (Write commit message as "Small Message")

    git commit -m "Write a meaningful but small commit message"

  • Step 8: Push the changes for review

    git push -u origin <branch-name>

  • Step 9: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

Bug Reports

If you encounter any bugs or issues while using the project, please follow these steps:

  1. Check if the issue has already been reported by searching the existing issues.
  2. If the issue has not been reported, open a new issue.
  3. Provide a clear and descriptive title for the issue.
  4. Include steps to reproduce the issue.
  5. Describe the expected behavior and the actual behavior.
  6. Provide any relevant error messages or screenshots.

Feature Requests

If you have a feature request, please follow these steps:

  1. Check if the feature has already been requested by searching the existing issues.
  2. If the feature has not been requested, open a new issue.
  3. Provide a clear and descriptive title for the feature request.
  4. Describe the problem or use case that the feature would address.
  5. Provide a clear description of the proposed solution or implementation.

Community Guidelines

When participating in discussions and contributing to the project, we kindly ask you to follow our community guidelines. These guidelines ensure a positive and inclusive environment for everyone involved. Please review the README.md file for more information.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project.