Skip to content

Commit 7d44904

Browse files
committed
Merge branch 'chore/standardize-readmes-2026-05' into main
2 parents 9f0eb34 + e559e61 commit 7d44904

7 files changed

Lines changed: 352 additions & 109 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 Go
2+
3+
Thanks for your interest in contributing to Evolution Go! 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-go/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 Go better!
85+
86+
---
87+
88+
© 2026 Evolution Foundation

LICENSE

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Evolution Go License
2+
3+
Evolution Go is licensed under the Apache License 2.0, with the following additional conditions:
4+
5+
1. Evolution Go 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:
6+
7+
a. **LOGO and copyright information**: In the process of using Evolution Go's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution Go console or applications. This restriction is inapplicable to uses of Evolution Go that do not involve its frontend components.
8+
9+
b. **Usage Notification Requirement**: If Evolution Go 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 Go 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.
10+
11+
Please contact suporte@evofoundation.com.br to inquire about licensing matters.
12+
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.
14+
15+
---
116

217
Apache License
318
Version 2.0, January 2004
@@ -49,7 +64,7 @@
4964
"Contribution" shall mean any work of authorship, including
5065
the original version of the Work and any modifications or additions
5166
to that Work or Derivative Works thereof, that is intentionally
52-
submitted to the Licensor for inclusion in the Work by the copyright owner
67+
submitted to Licensor for inclusion in the Work by the copyright owner
5368
or by an individual or Legal Entity authorized to submit on behalf of
5469
the copyright owner. For the purposes of this definition, "submitted"
5570
means any form of electronic, verbal, or written communication sent
@@ -61,7 +76,7 @@
6176
designated in writing by the copyright owner as "Not a Contribution."
6277

6378
"Contributor" shall mean Licensor and any individual or Legal Entity
64-
on behalf of whom a Contribution has been received by the Licensor and
79+
on behalf of whom a Contribution has been received by Licensor and
6580
subsequently incorporated within the Work.
6681

6782
2. Grant of Copyright License. Subject to the terms and conditions of
@@ -107,7 +122,7 @@
107122
(d) If the Work includes a "NOTICE" text file as part of its
108123
distribution, then any Derivative Works that You distribute must
109124
include a readable copy of the attribution notices contained
110-
within such NOTICE file, excluding any notices that do not
125+
within such NOTICE file, excluding those notices that do not
111126
pertain to any part of the Derivative Works, in at least one
112127
of the following places: within a NOTICE text file distributed
113128
as part of the Derivative Works; within the Source form or
@@ -188,4 +203,6 @@
188203
distributed under the License is distributed on an "AS IS" BASIS,
189204
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190205
See the License for the specific language governing permissions and
191-
limitations under the License.
206+
limitations under the License.
207+
208+
© 2026 Evolution Foundation

NOTICE

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
Evolution Foundation
1+
Evolution Go
22
Copyright 2026 Evolution Foundation
33

4-
This product includes software developed by Evolution Foundation.
4+
This product includes software developed by Evolution Foundation
5+
(https://evolutionfoundation.com.br).
56

67
Trademark notice
7-
"Evolution Foundation" and "Evolution" are trademarks of Evolution Foundation. The Evolution Foundation logo, wordmark, and Evolution Foundation visual identity are governed by the Evolution Foundation Trademark and Brand Assets Policy included in this repository.
8+
"Evolution Foundation", "Evolution" and "Evolution Go" are trademarks of
9+
Evolution Foundation. The Evolution Go 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 developed by external contributors:
16+
17+
- whatsmeow (https://github.com/tulir/whatsmeow) by Tulir Asokan, used as the
18+
WhatsApp protocol library.

0 commit comments

Comments
 (0)