Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 2.9 KB
Raw

🌟 Contributing Guide

Thank you for your interest in contributing to this project! 🎉 Your help keeps this project growing and improving. Below are the different ways you can contribute. Let’s get started! 🚀

🏦 Adding a New Bank

The list of banks is automatically updated daily using the MergeTool.

However, if the tool cannot find the data for a specific bank, you can help by:

  1. Opening a Bug Report issue.
  2. Including all the necessary details about the bank, such as:
    • Bank name
    • Code
    • Country or region
    • Any additional relevant data

We will manually add the bank to the JSON file and ensure it is included in future updates. ✅

🗑️ Removing a Bank

If a bank needs to be removed (e.g., it no longer exists or merged with another), you can:

  1. Open a Bug Report issue.
  2. Include the following details:
    • The name and code of the bank to be removed.
    • The reason for its removal (e.g., discontinued, merged).
    • Supporting evidence or links to verify the request.

We’ll handle the removal manually in the JSON file and update the project accordingly. 🔄

🔍 Adding a New Source of Data

  1. Open an issue describing the new data source you'd like to add.
  2. Include the following details:
    • 📂 The type of data the source provides.
    • 🔗 A link to the source (if applicable).
    • 📜 Any requirements, licenses, or permissions to use the data.

Make sure the source aligns with the project’s goals and standards. 🌟

🐞 Reporting a Bug/Problem

  1. Open an issue using the Bug Report template.
  2. Include as much detail as possible, such as:
    • ⚙️ Steps to reproduce the issue.
    • 🖼️ Screenshots, error logs, or examples (if available).
    • 📋 The expected vs. actual behavior.

This helps us identify and fix the problem faster! 🚑

💡 Other Kinds of Contributions

Do you have ideas or want to improve something else?

  1. Open a new issue and describe your suggestion (e.g., documentation updates, new features, refactoring).
  2. Be as detailed as possible so we can discuss and collaborate effectively.

Your creativity is always welcome here! 🎨

🔧 Merge Tool: Key Information

  • This project uses MergeTool to manage and update the data daily.
  • ⚠️ Important: The JSON file is the source of truth. If you're making code changes, ensure they don’t conflict with the MergeTool's updates.
  • The MergeTool ensures the data is up-to-date and consistent across all parts of the project.

Thank you for contributing and helping improve this project! Together, we’re building something amazing. 💪
If you have any questions, feel free to open an issue or start a discussion. 😊

Happy contributing! 🚀