Skip to content

Commit 625790e

Browse files
authored
Update README.md
1 parent 178848a commit 625790e

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ It is designed to provide reliable and intuitive transaction management for miss
1414

1515
## Getting Started
1616
* API Documentation is available at [here](/docs/api.md).
17-
* Supported drivers are available at [here](/docs/drivers.md).
17+
* Native supported drivers are available at [here](/docs/drivers.md).
1818
* The [example](/examples) contains a simple example of how to use the TranJS framework.
1919

2020
## Usage
@@ -55,6 +55,29 @@ It should be set up for the database you want to use. See [here](/docs/drivers.m
5555
> [!NOTE]
5656
> If the driver you want to use does not exist, [you can implement it on your own.](/docs/self-implement-guide.md)
5757
58-
## LICENSE
58+
## Contribute
59+
60+
TranJS welcomes contributions from the community to enhance its functionality and usability. Here’s how you can contribute:
61+
62+
1. **Report Issues**
63+
If you encounter bugs or have suggestions for improvements, feel free to open an issue in the repository.
64+
65+
2. **Submit Pull Requests**
66+
Fork the repository, create a new branch for your changes, and submit a pull request. Ensure your code adheres to the project's coding standards and includes relevant tests.
67+
68+
3. **Implement Drivers**
69+
If the driver you need is not available, you can implement it yourself using the [self-implement guide](/docs/self-implement-guide.md).
70+
71+
4. **Improve Documentation**
72+
Contributions to the documentation are always appreciated—whether it's fixing typos, adding examples, or clarifying complex concepts.
73+
74+
5. **Collaborate and Review**
75+
Participate in discussions, review pull requests, and provide constructive feedback to other contributors.
76+
77+
## License
5978

6079
This project is licensed under the LGPL-2.1 License - see the [LICENSE](LICENSE) file for details.
80+
81+
## Acknowledgement
82+
83+
* [Spring JPA](https://github.com/spring-projects/spring-data-jpa)

0 commit comments

Comments
 (0)