Added Javadoc and instructions for contribution
This commit is contained in:
19
CONTRIBUTING.md
Normal file
19
CONTRIBUTING.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## Contributing
|
||||
|
||||
Contributions from the community are welcome! To contribute:
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a new branch for your feature or bug fix.
|
||||
3. Make your changes with proper testing.
|
||||
4. Submit a pull request detailing your modifications.
|
||||
|
||||
### Developer Documentation
|
||||
|
||||
Developer documentation is generated using JavaDoc. To generate and view the documentation:
|
||||
|
||||
```bash
|
||||
chmod +x generate_javadoc.sh
|
||||
./generate_javadoc.sh
|
||||
```
|
||||
|
||||
This will create a `docs/` folder with HTML documentation you can view in your browser.
|
||||
Reference in New Issue
Block a user