Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

96 lines (69 loc) · 3.29 KB

Here's a basic CONTRIBUTING.md file you can use for your CodeChatter-v2 repository to guide contributors on how to contribute to the project:

Contributing to CodeChatter-v2

Thank you for considering contributing to CodeChatter-v2! We welcome all types of contributions, including code, documentation, bug reports, and feature suggestions. Please follow the guidelines below to help make the process smooth for everyone.

How to Contribute

1. Fork the Repository

  1. Navigate to the CodeChatter-v2 repository.
  2. Click the Fork button to create a copy of the repository under your GitHub account.

2. Clone the Repository

After forking, clone the repository to your local machine:

git clone https://github.com/yashksaini-coder/CodeChatter-v2.git
cd CodeChatter-v2

3. Create a New Branch

Create a new branch for your feature or bugfix:

git checkout -b feature-or-bugfix-description

4. Install Dependencies

Make sure you have the required dependencies installed. You can install them by running:

pip install -r requirements.txt

5. Make Your Changes

Make your code changes or contributions in this branch. Be sure to follow these guidelines:

  • Write clean, readable, and maintainable code.
  • Adhere to PEP 8 for Python code style.
  • Update documentation as needed.
  • Write meaningful commit messages.

6. Test Your Changes

Before submitting your changes, ensure that the application runs smoothly, and any new code is tested.

7. Commit and Push Your Changes

Commit your changes to the branch:

git add .
git commit -m "Description of the feature or bug fix"

Then push the branch to your forked repository:

git push origin feature-or-bugfix-description

8. Submit a Pull Request (PR)

  1. Go to the Pull Requests section of the original repository.
  2. Click on New Pull Request.
  3. Select your branch and submit your PR.
  4. In the pull request description, include:
    • What changes were made.
    • Why these changes were made.
    • Any relevant issue or bug it resolves.

We will review your PR as soon as possible!

Reporting Bugs and Requesting Features

Bug Reports

If you encounter a bug, please create a new issue with the following information:

  • Description: A clear and concise description of the bug.
  • Steps to Reproduce: How can we replicate the bug?
  • Expected Behavior: What should happen instead?
  • Screenshots: If applicable, add screenshots to help explain the problem.

Feature Requests

For feature requests, please open a new issue and describe:

  • What the feature does.
  • Why it is useful.
  • How it could be implemented.

Improving the UI/UX & Front-End Design

If you'd like to contribute to the UI/UX or Front-End design of the CodeChatter-v2 app, feel free to suggest ideas or open an issue here.

Code of Conduct

Please note that we have a Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to CodeChatter-v2! We look forward to collaborating with you!