OneSignal MCP Server
by WeirdBrains
Verified
# Contributing to OneSignal MCP Server
Thank you for considering contributing to the OneSignal MCP Server! This document provides guidelines and instructions for contributing to this project.
## Code of Conduct
Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
## How to Contribute
### Reporting Bugs
If you find a bug, please create an issue with the following information:
- A clear, descriptive title
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Any relevant logs or error messages
- Your environment (OS, Python version, etc.)
### Suggesting Features
If you have an idea for a new feature, please create an issue with:
- A clear, descriptive title
- A detailed description of the feature
- Any relevant examples or use cases
- Why this feature would be beneficial
### Pull Requests
1. Fork the repository
2. Create a new branch for your changes
3. Make your changes
4. Run tests to ensure your changes don't break existing functionality
5. Submit a pull request
### Development Setup
1. Clone the repository
2. Install dependencies:
```
pip install -r requirements.txt
```
3. Create a `.env` file with your OneSignal credentials (see `.env.example`)
## Coding Standards
- Follow PEP 8 style guidelines
- Write docstrings for all functions, classes, and modules
- Include type hints where appropriate
- Write tests for new functionality
## Testing
Before submitting a pull request, please ensure that all tests pass. You can run tests with:
```
# TODO: Add testing instructions once tests are implemented
```
## Documentation
Please update documentation when making changes:
- Update docstrings for modified functions
- Update the README.md if necessary
- Add examples for new functionality
## License
By contributing to this project, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).