-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into gitauto/issue-#230-d915bc33-e153-4495-bb3c-cβ¦
β¦ef91c303b65
- Loading branch information
Showing
20 changed files
with
795 additions
and
335 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,4 +23,4 @@ jobs: | |
fetch-depth: 0 | ||
|
||
- name: Infisical secrets check | ||
uses: guibranco/[email protected].16 | ||
uses: guibranco/[email protected].21 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,81 @@ | ||
# How to contribute | ||
# π Contributing Guide | ||
|
||
First of all, thanks for reading this doc! | ||
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! π | ||
|
||
Open a new issue with **Request new bank** template, and fill in the information of the bank in the issue. | ||
The template already asks for all the needed information. | ||
--- | ||
|
||
The data is updated daily using a tool called [MergeTool](https://github.com/guibranco/BancosBrasileiros-MergeTool). | ||
If you are doing some hard code changes, please make sure it will not be overwritten by the merge tool. The source of truth is the JSON file and is used by the Merge Tool to load the initial data. | ||
## π¦ Adding a New Bank | ||
|
||
The list of banks is automatically updated daily using the [MergeTool](https://github.com/guibranco/BancosBrasileiros-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](https://github.com/guibranco/BancosBrasileiros-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! π |
Oops, something went wrong.