docs: contributing.md

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+Thank you for your interest in contributing to our project! Here's how you can help:
+
+## Reporting Issues
+
+- Use GitHub Issues to report bugs.
+- Provide as much detail as you can.
+
+## Requests for new features
+
+If you have a request for a new feature, please open a discussion on GitHub. We'll be happy to help you out.
+
+## Making Changes
+
+- Fork the repository and create a branch for your work.
+- Make your changes.
+- Submit a pull request with a clear description of what you've done.
+- 
+Before you commit, run `npm run lint` to check your code for errors and `npm run format:write` to format your code.
+
+## Guidelines
+
+- Keep code changes simple and focused.
+- Follow the existing coding style.
+
+## Commit Convention
+
+Before you create a Pull Request, please check whether your commits comply with
+the commit conventions used in this repository.
+
+When you create a commit we kindly ask you to follow the convention
+`category(scope or module): message` in your commit message while using one of
+the following categories:
+
+- `feat / feature`: all changes that introduce completely new code or new
+  features
+- `fix`: changes that fix a bug (ideally you will additionally reference an
+  issue if present)
+- `refactor`: any code related change that is not a fix nor a feature
+- `docs`: changing existing or creating new documentation (i.e. README, docs for
+  usage of a lib or cli usage)
+- `build`: all changes regarding the build of the software, changes to
+  dependencies or the addition of new dependencies
+- `test`: all changes regarding tests (adding new tests or changing existing
+  ones)
+- `ci`: all changes regarding the configuration of continuous integration (i.e.
+  github actions, ci system)
+- `chore`: all changes to the repository that do not fit into any of the above
+  categories
+
+  e.g. `feat(components): add new prop to the avatar component`
+
+If you are interested in the detailed specification you can visit
+https://www.conventionalcommits.org/ or check out the
+[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).
+
+## Remember
+
+- All contributions are under the same license as the project.
+
+Your contributions are greatly appreciated!

README.md

@@ -24,6 +24,8 @@ cp .env.example .env.local
 npm run dev
 ```
 
+Read more about how to contribute to this project in [contributing guide](/CONTRIBUTING.md).
+
 ## License
 
 Licensed under the [MIT license](https://github.com/arshad-yaseen/markdx/blob/main/LICENSE.md).