Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mob-sakai committed Nov 20, 2023
1 parent 7c3f912 commit 9bf490f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
23 changes: 18 additions & 5 deletions Packages/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Packages/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Issues are incredibly valuable to this project:
### Pull Requests

Pull requests offer a fantastic way to contribute your ideas to this repository.
Please refer to [CONTRIBUTING.md](/../../blob/main/CONTRIBUTING.md) for guidelines.
Please refer to [CONTRIBUTING.md](/../../blob/main/CONTRIBUTING.md) and [develop branch](https://github.com/mob-sakai/UpmGitExtension/tree/develop) for guidelines.

### Support

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- `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.
7. Create a pull request on GitHub. Fill out the description, link any related issues and submit your pull request.

For details, refer to [CONTRIBUTING](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/main/CONTRIBUTING.md)
and [CODE_OF_CONDUCT](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/main/CODE_OF_CONDUCT.md).
Expand Down

0 comments on commit 9bf490f

Please sign in to comment.