UNPKG

create-benm-app

Version:

Boilerplate for REST API with Node.js, ExpressJS, and MongoDB

28 lines (17 loc) 1.34 kB
# Contributing First off, Thank you 🙏 so much for taking the time to contribute. All contributions are more than welcome! ## How can I contribute? 🤔 If you have an awesome new feature that you want to implement or you found a bug that you would like to fix, here are some instructions to guide you through the process: - **Create an issue** to explain and discuss the details ( [How to Create issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) ) - **Fork the repo** ( [How to fork repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) ) - **Clone the repo** and set it up (check out the [manual installation](https://github.com/umagol/BENM) section in README.md) ```sh git clone https://github.com/umagol/BENM ``` - **Implement** the necessary changes - **Create tests** to keep the code coverage high - **Send a pull request** ### Coding style guide We are using ESLint to ensure a consistent code style in the project, based on [Airbnb's JS style guide](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base). Some other ESLint plugins are also being used, such as the [Prettier](https://github.com/prettier/eslint-plugin-prettier). Please make sure that the code you are pushing conforms to the style guides mentioned above.