Skip to content

Commit c934ad0

Browse files
DavidsonGomesDavidsonGomes
committed
Merge branch 'chore/standardize-readmes-2026-05' into main
2 parents cd800f2 + b3a9176 commit c934ad0

7 files changed

Lines changed: 617 additions & 179 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Contributing to Evolution API
2+
3+
Thanks for your interest in contributing to Evolution API! This document
4+
outlines how to contribute effectively.
5+
6+
## Code of Conduct
7+
8+
All contributors are expected to be respectful, inclusive, and professional.
9+
Harassment, discrimination, or abusive behavior will not be tolerated.
10+
11+
## How to Contribute
12+
13+
### Reporting Bugs
14+
15+
1. Check existing [issues](https://github.com/EvolutionAPI/evolution-api/issues)
16+
to avoid duplicates
17+
2. Open a new issue with:
18+
- Clear, descriptive title
19+
- Steps to reproduce
20+
- Expected vs actual behavior
21+
- Environment details (OS, version, dependencies)
22+
- Logs or screenshots when relevant
23+
24+
### Suggesting Features
25+
26+
1. Open an issue describing:
27+
- The problem you're trying to solve
28+
- Your proposed solution
29+
- Alternatives you considered
30+
2. Wait for maintainer feedback before starting implementation
31+
32+
### Submitting Pull Requests
33+
34+
1. Fork the repository
35+
2. Create a feature branch from `develop`:
36+
```bash
37+
git checkout -b feat/your-feature-name
38+
```
39+
3. Make your changes following the project's coding standards
40+
4. Write or update tests for your changes
41+
5. Ensure all tests pass and the code lints clean
42+
6. Commit using [Conventional Commits](https://www.conventionalcommits.org/):
43+
```
44+
feat: add new feature
45+
fix: resolve bug in X
46+
docs: update README
47+
refactor: simplify Y
48+
test: add coverage for Z
49+
```
50+
7. Push to your fork and open a PR against `develop`
51+
8. Fill out the PR template with context, testing notes, and screenshots if
52+
applicable
53+
54+
## Development Setup
55+
56+
See [README.md](./README.md) for project-specific setup instructions.
57+
58+
## Code Standards
59+
60+
- Follow the existing code style of the project
61+
- Run linters and formatters before committing
62+
- Add tests for new features and bug fixes
63+
- Document public APIs and non-obvious behavior
64+
- Keep commits atomic and focused
65+
66+
## Branch Strategy
67+
68+
- `main` — stable production-ready code
69+
- `develop` — integration branch for upcoming releases
70+
- `feat/*`, `fix/*`, `chore/*` — short-lived branches off `develop`
71+
72+
## Trademark Notice
73+
74+
By contributing, you agree that your contributions will be licensed under the
75+
Apache License 2.0 (see [LICENSE](./LICENSE)). Trademarks and brand assets are
76+
governed separately by [TRADEMARKS.md](./TRADEMARKS.md).
77+
78+
## Questions?
79+
80+
- **Community**: [evolutionfoundation.com.br/community](https://evolutionfoundation.com.br/community)
81+
- **Documentation**: [docs.evolutionfoundation.com.br](https://docs.evolutionfoundation.com.br)
82+
- **Email**: suporte@evofoundation.com.br
83+
84+
Thanks for helping make Evolution API better!
85+
86+
---
87+
88+
© 2026 Evolution Foundation

‎LICENSE‎

Lines changed: 195 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,205 @@ Evolution API is licensed under the Apache License 2.0, with the following addit
44

55
1. Evolution API may be utilized commercially, including as a backend service for other applications or as an application development platform for enterprises. Should the conditions below be met, a commercial license must be obtained from the producer:
66

7-
a. LOGO and copyright information: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components.
7+
a. **LOGO and copyright information**: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components.
88

9-
b. Usage Notification Requirement: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer.
9+
b. **Usage Notification Requirement**: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer.
1010

11-
Please contact contato@evolution-api.com to inquire about licensing matters.
11+
Please contact suporte@evofoundation.com.br to inquire about licensing matters.
1212

13-
2. As a contributor, you should agree that:
13+
Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0.
1414

15-
a. The producer can adjust the open-source agreement to be more strict or relaxed as deemed necessary.
16-
b. Your contributed code may be used for commercial purposes, including but not limited to its cloud business operations.
15+
---
1716

18-
Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0.
17+
Apache License
18+
Version 2.0, January 2004
19+
http://www.apache.org/licenses/
20+
21+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
22+
23+
1. Definitions.
24+
25+
"License" shall mean the terms and conditions for use, reproduction,
26+
and distribution as defined by Sections 1 through 9 of this document.
27+
28+
"Licensor" shall mean the copyright owner or entity authorized by
29+
the copyright owner that is granting the License.
30+
31+
"Legal Entity" shall mean the union of the acting entity and all
32+
other entities that control, are controlled by, or are under common
33+
control with that entity. For the purposes of this definition,
34+
"control" means (i) the power, direct or indirect, to cause the
35+
direction or management of such entity, whether by contract or
36+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
37+
outstanding shares, or (iii) beneficial ownership of such entity.
38+
39+
"You" (or "Your") shall mean an individual or Legal Entity
40+
exercising permissions granted by this License.
41+
42+
"Source" form shall mean the preferred form for making modifications,
43+
including but not limited to software source code, documentation
44+
source, and configuration files.
45+
46+
"Object" form shall mean any form resulting from mechanical
47+
transformation or translation of a Source form, including but
48+
not limited to compiled object code, generated documentation,
49+
and conversions to other media types.
50+
51+
"Work" shall mean the work of authorship, whether in Source or
52+
Object form, made available under the License, as indicated by a
53+
copyright notice that is included in or attached to the work
54+
(an example is provided in the Appendix below).
55+
56+
"Derivative Works" shall mean any work, whether in Source or Object
57+
form, that is based on (or derived from) the Work and for which the
58+
editorial revisions, annotations, elaborations, or other modifications
59+
represent, as a whole, an original work of authorship. For the purposes
60+
of this License, Derivative Works shall not include works that remain
61+
separable from, or merely link (or bind by name) to the interfaces of,
62+
the Work and Derivative Works thereof.
63+
64+
"Contribution" shall mean any work of authorship, including
65+
the original version of the Work and any modifications or additions
66+
to that Work or Derivative Works thereof, that is intentionally
67+
submitted to Licensor for inclusion in the Work by the copyright owner
68+
or by an individual or Legal Entity authorized to submit on behalf of
69+
the copyright owner. For the purposes of this definition, "submitted"
70+
means any form of electronic, verbal, or written communication sent
71+
to the Licensor or its representatives, including but not limited to
72+
communication on electronic mailing lists, source code control systems,
73+
and issue tracking systems that are managed by, or on behalf of, the
74+
Licensor for the purpose of discussing and improving the Work, but
75+
excluding communication that is conspicuously marked or otherwise
76+
designated in writing by the copyright owner as "Not a Contribution."
77+
78+
"Contributor" shall mean Licensor and any individual or Legal Entity
79+
on behalf of whom a Contribution has been received by Licensor and
80+
subsequently incorporated within the Work.
81+
82+
2. Grant of Copyright License. Subject to the terms and conditions of
83+
this License, each Contributor hereby grants to You a perpetual,
84+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
85+
copyright license to reproduce, prepare Derivative Works of,
86+
publicly display, publicly perform, sublicense, and distribute the
87+
Work and such Derivative Works in Source or Object form.
88+
89+
3. Grant of Patent License. Subject to the terms and conditions of
90+
this License, each Contributor hereby grants to You a perpetual,
91+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
92+
(except as stated in this section) patent license to make, have made,
93+
use, offer to sell, sell, import, and otherwise transfer the Work,
94+
where such license applies only to those patent claims licensable
95+
by such Contributor that are necessarily infringed by their
96+
Contribution(s) alone or by combination of their Contribution(s)
97+
with the Work to which such Contribution(s) was submitted. If You
98+
institute patent litigation against any entity (including a
99+
cross-claim or counterclaim in a lawsuit) alleging that the Work
100+
or a Contribution incorporated within the Work constitutes direct
101+
or contributory patent infringement, then any patent licenses
102+
granted to You under this License for that Work shall terminate
103+
as of the date such litigation is filed.
104+
105+
4. Redistribution. You may reproduce and distribute copies of the
106+
Work or Derivative Works thereof in any medium, with or without
107+
modifications, and in Source or Object form, provided that You
108+
meet the following conditions:
109+
110+
(a) You must give any other recipients of the Work or
111+
Derivative Works a copy of this License; and
112+
113+
(b) You must cause any modified files to carry prominent notices
114+
stating that You changed the files; and
115+
116+
(c) You must retain, in the Source form of any Derivative Works
117+
that You distribute, all copyright, patent, trademark, and
118+
attribution notices from the Source form of the Work,
119+
excluding those notices that do not pertain to any part of
120+
the Derivative Works; and
121+
122+
(d) If the Work includes a "NOTICE" text file as part of its
123+
distribution, then any Derivative Works that You distribute must
124+
include a readable copy of the attribution notices contained
125+
within such NOTICE file, excluding those notices that do not
126+
pertain to any part of the Derivative Works, in at least one
127+
of the following places: within a NOTICE text file distributed
128+
as part of the Derivative Works; within the Source form or
129+
documentation, if provided along with the Derivative Works; or,
130+
within a display generated by the Derivative Works, if and
131+
wherever such third-party notices normally appear. The contents
132+
of the NOTICE file are for informational purposes only and
133+
do not modify the License. You may add Your own attribution
134+
notices within Derivative Works that You distribute, alongside
135+
or as an addendum to the NOTICE text from the Work, provided
136+
that such additional attribution notices cannot be construed
137+
as modifying the License.
138+
139+
You may add Your own copyright statement to Your modifications and
140+
may provide additional or different license terms and conditions
141+
for use, reproduction, or distribution of Your modifications, or
142+
for any such Derivative Works as a whole, provided Your use,
143+
reproduction, and distribution of the Work otherwise complies with
144+
the conditions stated in this License.
145+
146+
5. Submission of Contributions. Unless You explicitly state otherwise,
147+
any Contribution intentionally submitted for inclusion in the Work
148+
by You to the Licensor shall be under the terms and conditions of
149+
this License, without any additional terms or conditions.
150+
Notwithstanding the above, nothing herein shall supersede or modify
151+
the terms of any separate license agreement you may have executed
152+
with Licensor regarding such Contributions.
153+
154+
6. Trademarks. This License does not grant permission to use the trade
155+
names, trademarks, service marks, or product names of the Licensor,
156+
except as required for reasonable and customary use in describing the
157+
origin of the Work and reproducing the content of the NOTICE file.
158+
159+
7. Disclaimer of Warranty. Unless required by applicable law or
160+
agreed to in writing, Licensor provides the Work (and each
161+
Contributor provides its Contributions) on an "AS IS" BASIS,
162+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
163+
implied, including, without limitation, any warranties or conditions
164+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
165+
PARTICULAR PURPOSE. You are solely responsible for determining the
166+
appropriateness of using or redistributing the Work and assume any
167+
risks associated with Your exercise of permissions under this License.
168+
169+
8. Limitation of Liability. In no event and under no legal theory,
170+
whether in tort (including negligence), contract, or otherwise,
171+
unless required by applicable law (such as deliberate and grossly
172+
negligent acts) or agreed to in writing, shall any Contributor be
173+
liable to You for damages, including any direct, indirect, special,
174+
incidental, or consequential damages of any character arising as a
175+
result of this License or out of the use or inability to use the
176+
Work (including but not limited to damages for loss of goodwill,
177+
work stoppage, computer failure or malfunction, or any and all
178+
other commercial damages or losses), even if such Contributor
179+
has been advised of the possibility of such damages.
180+
181+
9. Accepting Warranty or Additional Liability. While redistributing
182+
the Work or Derivative Works thereof, You may choose to offer,
183+
and charge a fee for, acceptance of support, warranty, indemnity,
184+
or other liability obligations and/or rights consistent with this
185+
License. However, in accepting such obligations, You may act only
186+
on Your own behalf and on Your sole responsibility, not on behalf
187+
of any other Contributor, and only if You agree to indemnify,
188+
defend, and hold each Contributor harmless for any liability
189+
incurred by, or claims asserted against, such Contributor by reason
190+
of your accepting any such warranty or additional liability.
191+
192+
END OF TERMS AND CONDITIONS
193+
194+
Copyright 2026 Evolution Foundation
195+
196+
Licensed under the Apache License, Version 2.0 (the "License");
197+
you may not use this file except in compliance with the License.
198+
You may obtain a copy of the License at
199+
200+
http://www.apache.org/licenses/LICENSE-2.0
19201

20-
© 2025 Evolution API
202+
Unless required by applicable law or agreed to in writing, software
203+
distributed under the License is distributed on an "AS IS" BASIS,
204+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205+
See the License for the specific language governing permissions and
206+
limitations under the License.
21207

208+
© 2026 Evolution Foundation

‎NOTICE‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Evolution API
2+
Copyright 2026 Evolution Foundation
3+
4+
This product includes software developed by Evolution Foundation
5+
(https://evolutionfoundation.com.br).
6+
7+
Trademark notice
8+
"Evolution Foundation", "Evolution" and "Evolution API" are trademarks of
9+
Evolution Foundation. The Evolution API logo, wordmark, and visual identity
10+
are governed by the Trademark and Brand Assets Policy included in this
11+
repository (TRADEMARKS.md).
12+
13+
Third-party attributions
14+
15+
This product includes software derived from CodeChat WhatsApp API
16+
(https://github.com/code-chat-br/whatsapp-api), originally licensed under MIT.
17+
The CodeChat project implemented the Baileys library
18+
(https://github.com/WhiskeySockets/Baileys), which Evolution API also uses for
19+
its WhatsApp Web integration.

0 commit comments

Comments
 (0)