Welcome to the Biyuya organization's repository! This document serves as a guide to help you understand our projects, contribution guidelines, and more.
Biyuya is an organization dedicated to developing high-quality software solutions. Our projects range from web and mobile applications to libraries and tools that aim to improve developers' productivity.
We welcome contributions from the community. Please follow these steps to contribute:
- Fork the repository you want to contribute to.
- Clone your fork to your local machine.
- Create a new branch using the branch naming convention (see below).
- Make your changes and commit them with clear and descriptive messages.
- Push your changes to your fork.
- Create a pull request to the main repository.
-
Create your feature branch
git checkout -b [EXA-123]-my-new-feature
-
Add files to commit
git add [path]
-
Commit your changes
git commit -m "feat[EXA-123]: description" -
Push to the branch
git push
Examples using conventional commits
| Type | Commit | Description |
|---|---|---|
| feat | feat: add new feature example | Introduces a new feature/component/functionality into the project |
| fix | fix: fix foo to enable bar | Fixes an error in your code base |
| chore | chore: add file to gitignore | Routine tasks not specific to a feature |
| build | build: change scripts to builds | Changes affecting the project's compilation |
| ci | ci: add new step to workflow ci | Changes affecting configuration files and scripts related to continuous integration |
| style | style: format functionality code | Changes in readability or code formatting that do not affect functionality |
| refactor | refactor: change component example | Code change that neither fixes errors nor adds functionality, but improves the code |
| perf | perf: using new pattern to optimize code | Used for performance improvements |
| revert | revert: revert last version | Reverts PR changes or if the commit reverts a previous commit |
| docs | docs: update readme | When only documentation is modified |
| merge | merge: update with main | Update active branch with main or another necessary branch |
| test | test: improve test coverage | Changes affecting tests and update snapshots |