Bless API Book - Learn and Integrate APIs

Bless API Book is an open-source project dedicated to making API integration easier for developers of all skill levels. We welcome contributions from the community to help expand our collection of API documentation, improve existing content, and enhance the overall user experience.

Ways to Contribute

Add API Documentation

Help expand our collection of API tutorials

Create comprehensive documentation for APIs not yet covered in our catalog. Follow our documentation template to ensure consistency.

Improve Existing Content

Help us keep our documentation up-to-date

Update existing API documentation to reflect changes in APIs, fix errors, or improve explanations and code examples.

Fix Bugs

Help improve the website functionality

Report bugs you encounter or submit pull requests to fix issues with the website's functionality or user interface.

Enhance Features

Help add new features to the platform

Contribute to the development of new features that would enhance the learning experience for users of Bless API Book.

Contribution Guidelines

Fork the Repository: Start by forking the Bless API Book repository on GitHub.
Create a Branch: Create a branch for your contribution with a descriptive name.
Follow the Style Guide: Ensure your contributions follow our documentation style guide and coding standards.
Test Your Changes: Make sure your changes work as expected and don't break existing functionality.
Submit a Pull Request: Once your contribution is ready, submit a pull request with a clear description of the changes.

Documentation Template

When adding new API documentation, please follow our template structure to ensure consistency across the platform:

Overview: A brief description of the API and its purpose.
Integration Guide: Step-by-step instructions for integrating the API.
Code Examples: Working code examples in HTML, CSS, and JavaScript.
Error Handling: Common errors and how to handle them.
API Details: Endpoints, parameters, and authentication methods.

Contribute through discord

Join Our Community

Have questions about contributing? Join our Discord community to connect with other contributors and get help with your contributions.

Join Our Discord

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. We are committed to providing a welcoming and inclusive environment for everyone, regardless of background or identity.

Recognition

All contributors will be recognized for their work. Your name will be added to our contributors list, and significant contributions may be highlighted in our newsletter and social media channels.