Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 3.63 KB

contributing.md

File metadata and controls

80 lines (60 loc) · 3.63 KB
Raw

Contribution Guidelines for Dropling Project

🚀 Welcome to Dropling! We're thrilled that you're interested in contributing to our project. This document outlines the guidelines and process for making contributions to Dropling. Whether you're a developer, designer, or enthusiast, your contributions play a crucial role in enhancing the Dropling experience for users worldwide.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Coding Standards
  4. Pull Request Process
  5. Community and Communication

Getting Started

Installation

To contribute to Dropling, you'll need to set up the project on your local machine. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/sayandippaul/dropling-chatapp

  2. cd the repository:

      cd dropling-chatapp

  3. Install dependencies:

    npm install

Running the Project

Start the development server:

npm run chat

Visit http://localhost:3000 in your browser to view Dropling. find your url and change the url to localhost in your public/js/url.js

How to Contribute

Reporting Bugs

If you encounter any bugs or issues while using Dropling, please report them. Use the [GitHub Issues]( cd dropling/issues) page to submit a detailed bug report. Include information such as your operating system, browser, and steps to reproduce the issue.

Suggesting Enhancements

Have ideas to improve Dropling? We'd love to hear them! Create an enhancement request on the GitHub Issues page. Describe the feature you're proposing and its potential benefits.

Code Contributions

Contributions to the codebase are highly valued. If you're considering a code contribution, ensure that it aligns with the project's goals. Fork the repository, create a new branch for your feature or fix, and submit a pull request.

Documentation

Good documentation is key to a successful project. Contribute to the documentation by improving existing content or adding information that benefits users and contributors. Documentation changes can be submitted through pull requests.

Coding Standards

Maintaining consistent coding standards is essential for a collaborative project. Adhere to the following guidelines:

  • Follow the JavaScript Standard Style for code formatting.
  • Use meaningful variable and function names.
  • Comment your code when necessary to provide clarity.
  • Ensure your code is well-tested before submitting a pull request.

Pull Request Process

  1. Fork the Dropling repository.
  2. Create a new branch for your feature or bug fix: git checkout -b your-name.
  3. Make your changes and ensure that your code adheres to the coding standards.
  4. Test your changes locally to verify that they work as expected.
  5. Commit your changes: git commit -m "Your meaningful commit message".
  6. Push your changes to your fork: git push origin feature-name.
  7. Submit a pull request to the main Dropling repository.

Thank you for considering contributing to Dropling! Your involvement helps make Dropling a dynamic and user-friendly platform. We look forward to your contributions and collaboration. Happy coding! 🚀🌐💬