Skip to content

Commit aaf56ab

Browse files
committed
Professionalize repo: badges, contributing, code of conduct, license, and polish for 2.0
1 parent cf80232 commit aaf56ab

File tree

4 files changed

+62
-0
lines changed

4 files changed

+62
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to foster a welcoming and respectful community for all. We are committed to making participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
4+
5+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer.
6+
7+
By participating, you agree to abide by this code of conduct.

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to PDF Professor
2+
3+
Thank you for considering contributing to PDF Professor 2.0! We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code enhancements.
4+
5+
## How to Contribute
6+
7+
1. Fork the repository and clone your fork.
8+
2. Create a new branch for your feature or bugfix.
9+
3. Make your changes and commit them with clear messages.
10+
4. Push your branch to your fork and open a Pull Request.
11+
5. Describe your changes in detail in the PR description.
12+
13+
## Guidelines
14+
- Follow the existing code style and structure.
15+
- Write clear, concise commit messages.
16+
- Add or update documentation as needed.
17+
- Ensure all tests pass before submitting a PR.
18+
19+
## Reporting Issues
20+
If you find a bug or have a feature request, please open an issue on GitHub with as much detail as possible.
21+
22+
Thank you for helping make PDF Professor better!

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 mbaosint
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
![PDF Professor Logo](80f7bd26-6e6a-4236-abf0-6f1418250f99.png)
22

33
# PDF Professor 2.0
4+
[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
5+
[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
46

57
## Overview
68

@@ -130,6 +132,16 @@ Enter your prompt for Ollama: Summarize key points.
130132

131133
---
132134

135+
## Contributing
136+
137+
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
138+
139+
## Code of Conduct
140+
141+
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md) to foster an open and welcoming environment.
142+
143+
---
144+
133145
## File Structure
134146

135147
```plaintext

0 commit comments

Comments
 (0)