CONTRIBUTING.md

Contributing to the Professional Nurse Advocate Assistant

Thank you for your interest in contributing to the Professional Nurse Advocate Assistant! We are building an open-source tool to support nursing professionals in restorative supervision and quality improvement.

🤝 How to Contribute

We welcome contributions from developers, nurses, and researchers. Here are a few ways you can help:

• Report Bugs: If you find a bug, please open an issue describing the problem and how to reproduce it.
• Suggest Features: Have an idea for a new feature? Open an issue to discuss it!
• Improve Documentation: Help us make the documentation clearer and more comprehensive.
• Submit Pull Requests: If you want to fix a bug or add a feature, please fork the repository and submit a pull request.

🛠️ Development Setup

1. Fork the repository on GitHub.
2. Clone your fork locally:

   git clone https://github.com/YOUR_USERNAME/Professional-Nurse-Advocate-Assistant.git
   cd Professional-Nurse-Advocate-Assistant
   

3. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

4. Install dependencies:

   pip install -r requirements.txt
   

5. Make your changes and test them locally:

   python app.py
   

📋 Pull Request Guidelines

• Ensure your code follows the existing style.
• Keep pull requests focused on a single change.
• Update documentation if necessary.
• We use Semantic Versioning for releases.

🏳️‍🌈 Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.

Please be respectful and constructive in all interactions.

📜 License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.