Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.09 KB

File metadata and controls

59 lines (35 loc) · 2.09 KB

Contributing to Chat-App

Welcome to the Chat-App repository! We are thrilled that you're interested in contributing to our project. Whether you're a beginner or an experienced developer, your help is highly appreciated.

Introduction

Chat-App is a realtime chat application where users can sign in and join rooms to chat with others. Our goal is to create a more user-friendly experience and add some new features. We welcome contributions from the students of IIESTS to help us grow and improve.

Table of Contents

How to Contribute

Forking the Repository

  1. Fork the repository by clicking on the "Fork" button in the top right corner of this page.
  2. Clone your forked repository to your local machine.

Creating a Pull Request

  1. Create a new branch for your changes:
git checkout -b my-feature-branch
  1. Make your changes and commit them with a clear message:
git commit -m "Description of the change"
  1. Push your changes back to your forked repository:
git push origin my-feature-branch
  1. Create a pull request to the main repository's main branch. Provide a description of what you have done and why it is beneficial.
  2. Make sure you include Fixes #issue_number or Closed #issue_number (Example- If you resolved #3 issue, then add Fixes #3)

Our maintainers will review your pull request. They may request changes or improvements. Once approved, your contribution will be merged!

Best Practices

To ensure that contributions are consistent and maintainable, please follow these best practices:

  1. Keep commits small and focused: A good rule of thumb is that each commit should represent one logical unit of work.
  2. Document your code: Please add comments or documentation where necessary, especially for complex code or logic.
  3. Test your code before creating a pull request.

Thank you for helping improve Chat-App! We look forward to your contributions.