Thank you for considering contributing to ServeMyAPI! This document provides guidelines and instructions for contributing to this project.
Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
- Fork the repository
- Clone your fork:
git clone https://github.com/yourusername/servemyapi.git - Install dependencies:
npm install - Create a new branch for your changes:
git checkout -b feature/your-feature-name
- Make your changes
- Run
npm run lintto ensure code style consistency - Test your changes:
- For stdio mode:
npm run dev - For HTTP mode:
npm run build && node dist/server.js
- For stdio mode:
- Commit your changes with a descriptive commit message
- Push to your branch:
git push origin feature/your-feature-name - Open a pull request against the main repository
- Ensure your code passes linting
- Update the README.md with details of your changes if appropriate
- Include a clear description of what your changes do and why they should be included
- Your PR will be reviewed by the maintainers, who may request changes
When adding new features:
- Consider backward compatibility
- Add appropriate documentation
- Follow the existing code style
Some potential areas for contribution:
- Adding support for other secure credential storage systems on different platforms
- Enhancing the web UI for managing keys directly
- Adding authentication for the HTTP server
- Creating client libraries for different programming languages
By contributing to ServeMyAPI, you agree that your contributions will be licensed under the project's MIT license.