CONTRIBUTING.md

Before contributing to this repository, you can either visit this article to understand more about contributing to Chimoney's projects or simply continue reading the guidelines below.

---

Contribution Guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Table of Contents

1. Types of Contributions
2. Workflow for Contributing
3. Commit Messages and Pull Requests
4. Branching Strategy
5. Testing Your Contribution
6. Code of Conduct
7. Additional Resources

Types of Contributions

You can contribute in several ways, including:

• Features: Adding new features to improve the project.
• Bug Fixes: Fixing any issues or bugs in the code.
• Documentation: Improving the documentation to help others contribute more easily.

Workflow for Contributing

Follow these steps to contribute to the repository:

1. Fork the Repository: Click the "Fork" button at the top-right corner of the repository page.
2. Clone the Repository: Clone the repository to your local machine using Git.

   git clone https://github.com/your-username/repository-name.git

3. Create a Branch: Create a new branch for your contribution.

   git checkout -b feature-branch-name

4. Make Your Changes: Add your code or documentation changes.
5. Test Your Changes: Ensure everything works by running tests locally.
6. Commit and Push:

   git commit -m "Your descriptive commit message"
   git push origin feature-branch-name

7. Submit a Pull Request: Go to GitHub and open a pull request.

Commit Messages and Pull Requests

• Write clear and concise commit messages. Example:

  feat: Add support for new payment API  
  fix: Resolve bug in transaction module  
  

• Provide detailed explanations in pull requests, including issue numbers if applicable.

Branching Strategy

Follow this simple branching strategy:

• main: For production-ready code.
• develop: For ongoing development work.
• feature/: For specific features or fixes.

Testing Your Contribution

Ensure that all contributions are tested. If you're using the Chimoney API, test using the Chimoney Sandbox:

• Sign up for Chimoney Sandbox here.
• Use your API keys to test transactions and integration.

Code of Conduct

We are committed to maintaining a welcoming and inclusive community. By participating, you agree to follow our Code of Conduct.

Additional Resources

• GitHub Flow Guide
• Chimoney API Documentation