Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

83 lines (51 loc) · 2.28 KB
Raw

Contributing to Chat Bridge

Thank you for your interest in contributing to Chat Bridge! — We appreciate your help in making this project better.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

If you're new to contributing to open source projects, you can start by looking at issues labeled as "good first issue" or "help wanted."

  1. Fork the repository.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/BadEnd777/Chat-Bridge.git

  3. Create a new branch for your changes:

    git checkout -b feature-or-fix-branch

  4. Make your changes and commit them:

    git add .
git commit -m "Description of your changes"

  5. Push your changes to your fork:

    git push origin feature-or-fix-branch

  6. Open a pull request (PR) against the main branch of the original repository.

Development Setup

To get started with development, follow these steps:

  1. Install the dependencies:

    npm install

  2. Create a new bot on Facebook and get your access token.

  3. Change the path of the library to your local path.

  4. Run the development server:

    node path/to/your/entry/file

Code Style

This project uses ESLint and Prettier to enforce a consistent code style. Please make sure to run npm run lint and npm run format before submitting a pull request.

Testing

To test your changes — Like a Development Setup section, you need to create a new bot on Facebook and test your changes.

Submitting a Pull Request

When submitting a pull request, please make sure to:

  • Provide a clear and concise description of the changes.
  • Reference the related issue if applicable.
  • Ensure that your changes pass all tests.
  • Keep the pull request focused on a single issue or feature.

Code Review

All contributions will go through a code review process. Be open to feedback and willing to make changes based on the review.

Thank You!

We appreciate your contribution to Chat Bridge. You're awesome! 🎉