Welcome to Planning Poker Minimal! This is a simple Vue 3 application for planning poker sessions. Planning poker is a technique used in agile software development to estimate the complexity of user stories or tasks. This minimalist version focuses on simplicity and ease of use.
We welcome contributions from the community to make Planning Poker Minimal even better. Whether you want to add new features, improve existing ones, fix bugs, or suggest enhancements, your contributions are highly appreciated.
To contribute to the project, follow these steps:
-
Fork the repository by clicking on the 'Fork' button at the top right corner of this page.
-
Clone your forked repository to your local machine:
https://github.com/your-username/planning-poker-minimal.git
-
Navigate to the project directory:
cd your-repo -
Project setup:
yarn
-
Compiles and hot-reloads for development:
yarn serve
-
Compiles and minifies for production:
yarn build
-
Create a new branch for your feature or bug fix:
git checkout -b feature/my-feature
-
Create a new branch for your feature or bug fix:
yarn test:unit
-
Make your changes and test thoroughly.
-
Lints and fixes files:
yarn lint
-
Commit your changes with descriptive commit messages:
git commit -m "Add my awesome feature" -
Push your branch to your forked repository:
git push origin feature/my-feature
-
Open a pull request by visiting the original repository and clicking on the 'New Pull Request' button.
-
Fill in the necessary details and describe your changes.
-
Submit the pull request, and wait for the project maintainers to review and merge your changes.
If you encounter any issues while using Planning Poker Minimal, please report them on the GitHub Issues page. We appreciate detailed bug reports that include steps to reproduce the issue and any relevant error messages.
This project is licensed under the MIT License.
We value and appreciate your contributions to Planning Poker Minimal. Let's build an amazing planning poker tool together!