Write Contributor's Guide #70

CODE_OF_CONDUCT.md

@@ -0,0 +1,33 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code

GUIDELINES.md

@@ -0,0 +1,60 @@
+# Contributor Guidelines
+
+Thank you for your interest in contributing to Podcastfy! We welcome contributions from the community to help improve and expand this project. Please follow these guidelines to ensure a smooth collaboration process.
+
+## Getting Started
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally: `git clone https://github.com/your-username/podcastfy.git`
+3. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
+
+## Code Style
+
+- Follow PEP 8 style guidelines for Python code.
+- Use tabs for indentation instead of spaces.
+- Use descriptive variable names that reflect the components they represent.
+- Include docstrings for all functions, classes, and modules.
+
+## Development
+
+- Poetry is used as the dependency manager. Install it with `pip install poetry`.
+- Sphinx is used as the documentation generator. Install it with `pip install sphinx`.
+    - `make doc-gen` to generate the documentation.
+
+
+## Submitting Changes
+
+1. Commit your changes with clear, descriptive commit messages.
+2. Push your changes to your fork on GitHub.
+3. Submit a pull request to the main repository.
+
+## Pre-Pull Request Checklist
+
+1. Managing dependencies
+    - Add new dependencies with `poetry add <new-dependency>` 
+    - Remove a dependency with `poetry remove <dependency-name>`. 
+    - Then generate requirements.txt with `poetry export -f requirements.txt --output requirements.txt --without-hashes`
+2. Testing
+    - Consider adding new tests at test/*.py, particularly if implementing user facing change.
+    - Test locally: `poetry run pytest`
+    - Tests (tests/*.py) are run automatically by GitHub Actions, double check that they pass.
+3. Docs
+    - Update any documentation if required README.md, usage/*.md, *.ipynb etc.
+    - Regenerate documentation (/docs) if there are any changes in docstrings or modules' interface (`make doc-gen`)
+
+
+## Reporting Issues
+
+- Use the GitHub issue tracker to report bugs or suggest enhancements.
+- Provide a clear and detailed description of the issue or suggestion.
+- Include steps to reproduce the bug, if applicable.
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+## Questions?
+
+If you have any questions or need further clarification, please don't hesitate to ask in the GitHub issues section.
+
+Thank you for contributing to Podcastfy!

README.md

@@ -114,7 +114,7 @@ Podcastfy offers a range of customization options to tailor your AI-generated po
 
 ## Contributing 🤝
 
-We welcome contributions! Please submit [Issues](https://github.com/souzatharsis/podcastfy/issues) or Pull Requests. Feel free to fork the repo and create your own applications. We're excited to learn about your use cases!
+We welcome contributions! See [Guidelines](GUIDELINES.md) for more details.
 
 ## Example Use Cases 🎧🎶