From f1e672470c3f731c7c3660daa4fb2eecc3d9067c Mon Sep 17 00:00:00 2001 From: mob-sakai Date: Mon, 29 Jan 2024 09:53:49 +0900 Subject: [PATCH] docs: update contributing --- CONTRIBUTING.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85176fb..cb0dd4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,11 +19,24 @@ When fixing a bug it is fine to submit a pull request right away. Steps to be performed to submit a pull request: -1. Fork the repository and create your branch from `develop`. -2. If you have fixed a bug or added code that should be tested, add tests. -3. Click `Window > Generals > Test Runner` to test -4. Commit with a massage based on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). -5. Fill out the description, link any related issues and submit your pull request. +1. Fork the repository. +2. Clone the repository. +3. Checkout `develop` branch. +4. Develop the package. +5. Test the package with the test runner (`Window > Generals > Test Runner`). +6. Commit with a message based + on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) as follows: + + - `fix:` fix a bug + - `feat:` new feature + - `docs:` changes only in documentation + - `style:` changes only in formatting, white-space, etc + - `refactor:` changes only in code structure (extract method, rename variable, move method, etc) + - `perf:` changes only in code performance + - `test:` add or update tests + - `chore:` changes to the build process or auxiliary tools and libraries such as documentation generation + +7. Create a pull request on GitHub. Fill out the description, link any related issues and submit your pull request. #### License