github.com/ergo-services/ergo@v1.999.224/CONTRIBUTING.md (about) 1 # Contributing to Ergo Framework 2 3 Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very 4 welcome to create or review pull requests and take part in discussions in any of our public [Discord community](https://discord.gg/sdscxKGV62), 5 [Telegram group](https://t.me/ergo_services) or [GitHub Discussions](https://github.com/ergo-services/ergo/discussions) 6 7 ## License 8 9 ```txt 10 By making a contribution to this project, I certify that: 11 12 (a) The contribution was created in whole or in part by me and I 13 have the right to submit it under the open source license 14 indicated in the file; or 15 16 (b) The contribution is based upon previous work that, to the 17 best of my knowledge, is covered under an appropriate open 18 source license and I have the right under that license to 19 submit that work with modifications, whether created in whole 20 or in part by me, under the same open source license (unless 21 I am permitted to submit under a different license), as 22 Indicated in the file; or 23 24 (c) The contribution was provided directly to me by some other 25 person who certified (a), (b) or (c) and I have not modified 26 it. 27 28 (d) I understand and agree that this project and the contribution 29 are public and that a record of the contribution (including 30 all personal information I submit with it, including my 31 sign-off) is maintained indefinitely and may be redistributed 32 consistent with this project or the open source license(s) 33 involved. 34 ``` 35 See [https://cla-assistant.io/ergo-services/ergo](https://cla-assistant.io/ergo-services/ergo) for a copy of the Developer Certificate of Origin license. 36 37 Ergo Framework is licensed under the MIT License, as stated in [LICENSE](LICENSE) file. 38 39 ## Reporting a bug or a feature request 40 41 Report bugs at https://github.com/ergo-services/ergo/issues 42 43 If you've found a **bug** or have a **feature request** then please create an issue in this repository (but search first in case a similar issue already exists). 44 45 ## Submitting Pull Requests 46 47 You can contribute to Ergo Framework by opening a Pull Request. If you would like to fix a bug or 48 implement a feature, please fork the repository and create a Pull Request. 49 50 Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts about requirement or implementation. 51 That way you can be sure that the maintainer(s) agree on what to change and how, and you can hopefully get a quick merge afterwards. 52 Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work. 53 54 In most cases, pull requests for new features should be based on the `master` branch. 55 56 Make sure that your feature does not break backward compatibility. In general, we only break backward 57 compatibility in major releases and only for a very good reason. 58 59 ## Collaboration with maintainers 60 61 Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you 62 spending an hour trying to work out something that would take us only a minute to explain.