diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1c84bb8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 + +If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests. + +Please note we have a [code of conduct](https://github.com/arifszn/blog-js/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. + +## Found an Issue? + +If you find a bug in the source code or a mistake in the documentation, you can help us by +submitting an issue to our [GitHub Repository](https://github.com/arifszn/blog-js/issues/new). Even better you can submit a Pull Request +with a fix. + +## Submitting a Pull Request + +- If applicable, update the `readme` +- Use `npm run lint` and `npm run prettier` before committing +- Example for a commit message + + ``` + Fix type validation for typescript + ``` + +### Developing + +Fork, then clone the repo: + +```sh +git clone https://github.com/your-username/blog-js.git +cd blog-js +``` + +Install dependencies: + +```sh +npm install +``` + +### Building + +Running the `build` task will create the `dist` version of the project. + +```sh +npm run build +``` + +### Project Structure + +```text +root +├── dist +└── src +└── types +``` diff --git a/README.md b/README.md index 8a2c3b5..09c3571 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ yarn add @arifszn/blog-js ## Contribute -To contribute, clone this repo locally and commit your code on a new branch. Feel free to create an issue or make a pull request. +To contribute, see the [Contributing guide](https://github.com/arifszn/blog-js/blob/main/CONTRIBUTING.md). ## Support