docs: some documents

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributions
+
+Thank you for your interest in contributing to this project :tada: :+1:
+
+This project is open for contributions, but before you start, please read the [code of conduct](CODE_OF_CONDUCT.md) and the [license](LICENSE).
+
+## How to contribute
+
+1. Fork this repository
+2. Create a new branch
+3. Commit your changes
+4. Push to the branch
+5. Create a new pull request
+6. Wait for the review
+
+## How to report a bug
+
+1. Go to the issues tab
+2. Click on the "New issue" button
+3. Select the "Bug report" template
+4. Fill the template
+5. Click on the "Submit new issue" button

README.md

@@ -0,0 +1,21 @@
+# issue validator
+
+## About
+
+This is a simple issue validator github action that checks if the issue/pr title and body are valid.
+
+## Usage
+
+wip
+
+## Example
+
+wip
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+wip

docs/example.md

@@ -0,0 +1,3 @@
+# Example
+
+wip

docs/usage.md

@@ -0,0 +1,3 @@
+# Usage
+
+wip