Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 2.07 KB
Raw

Contributing

Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

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.

Issues & Discussions

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! I'd love all and any contributions.

If you have questions, too, post a message in the Discussion section

Submitting Pull requests

⚠️ Disclaimer : This project uses private API keys that aren't available in the repository. Here are the environment variables that needs to be set :

BOTPOISON_PK=''
FORMSPARK_ACTION_URL=''
IMAGEKIT_B64_API=''
NPM_GREENSOCK_TOKEN=''

If you really wish to perfom PRs, here is what you can do :

  1. Fork and clone the repository.
  2. Make sure to read carefully the documentation.
  3. Configure and install the dependencies.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your change, add tests, and make sure the tests still pass.
  6. Push to your fork and submit a pull request.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide which is using standard. Any linting errors should be shown when running npm run eslint-fix.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Work in Progress pull requests are also welcome to get feedback early on.

Resources