diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d4ebb7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# 🙏 Contributing to Github Local Actions + +Thank you for your interest in contributing to **GitHub Local Actions**! Whether you're fixing a bug, adding a new feature, or improving the documentation, your contributions are highly valued and help make this project better for everyone. + +No contribution is too small—every bit helps! If you're unsure where to start, check out our [open issues](https://github.com/SanjulaGanepola/github-local-actions/issues) or reach out on our [discussion board](https://github.com/SanjulaGanepola/github-local-actions/discussions) to discuss your ideas. + +> 👉 Friendly Reminder: By contributing, you are agreeing to follow our [Code of Conduct](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CODE_OF_CONDUCT.md) guidelines. Let’s keep this a welcoming and fun space for everyone to collaborate! + +## Getting Started + +1. Install [VS Code](https://code.visualstudio.com/download) and [Node.js](https://nodejs.org/en/download/package-manager). +2. Create a [fork](https://github.com/SanjulaGanepola/github-local-actions/fork) of this repository. +3. Clone your fork. + ```sh + git clone https://github.com/your-username/github-local-actions.git + cd github-local-actions + ``` +4. Install all dependencies. + ```sh + npm install + ``` +5. Use `Run Extension` from VS Code's `Run and Debug` view. + +## Contributors + +Thanks so much to everyone [who has contributed](https://github.com/SanjulaGanepola/github-local-actions/graphs/contributors) to making GitHub Local Actions a success! + +* [@SanjulaGanepola](https://github.com/SanjulaGanepola) +* [@ChristopherHX](https://github.com/ChristopherHX) + +Want to see your name on this list? Join us and contribute! \ No newline at end of file diff --git a/README.md b/README.md index 88a0733..5454a4e 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Feel free to share any bugs or feature requests in the project's [GitHub Issues] ## Contribution -Contributions are always welcome! Please see our contributing guide for more details. +Contributions are always welcome! Please see our [contributing guide](https://github.com/SanjulaGanepola/github-local-actions/blob/main/CONTRIBUTING.md) for more details. ## Maintainers