Merge pull request #6 from Okabe-Junya/junya/docs/init

docs: some documents
Okabe-Junya · Sep 24, 2023 · ee279b5 · ee279b5
2 parents d44a723 + f9342f9
commit ee279b5
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.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
diff --git a/README.md b/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
diff --git a/docs/example.md b/docs/example.md
@@ -0,0 +1,3 @@
+# Example
+
+wip
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1,3 @@
+# Usage
+
+wip