-
Notifications
You must be signed in to change notification settings - Fork 0
licensing
This project, Currency Conversion Project, is licensed under two licenses: the MIT License and the Apache License 2.0. Details and reasons for this choice are described below.
To maximize flexibility and provide additional legal protection for users and contributors, this project is dual-licensed. This means you can choose to use this project under either the MIT License or the Apache License 2.0.
The MIT License is extremely permissive and straightforward. It allows users to do almost anything with the code, as long as they include the original license and copyright notice.
- Simplicity: The MIT License is short and easy to understand.
- Permissiveness: Allows modification, distribution, and commercial use with minimal restrictions.
The Apache License 2.0 is also a permissive license but includes additional legal protections, particularly related to patents.
- Patent Protection: Includes an explicit patent license, protecting users from patent litigation related to the licensed code.
- Safe Contributions: Requires contributors to declare that they have the right to contribute the code, reducing the risk of legal issues.
In the project repository, you will find two license files:
You can choose to use this project under either the MIT License or the Apache License 2.0. Just follow the conditions of one of the included licenses.
Offering both licenses allows different types of users to choose the license that best fits their needs:
- Independent Developers: May prefer the simplicity of the MIT License.
- Companies: May feel more secure with the additional protections of the Apache License 2.0.
Many popular open-source projects use the MIT License, while others use the Apache License. Offering both facilitates integration with other projects and is more acceptable to different developer communities.
To read the full texts of the licenses, consult the links below:
Thank you for contributing to and using the Currency Conversion Project. If you have questions about licensing, feel free to open an issue in the project repository.
- Overview: Presentation of the project, highlighting its purpose and the context in which it is embedded.
- Project Objectives: Enumeration of the main objectives that the project aims to achieve.
- Scope and Functionalities: Description of the main functionalities offered by the project and its scope of operation.
- Initial Configurations: Steps required to set up the development or production environment.
- Installation Instructions: Detailed procedures for installing the project in different environments.
- Docker Configuration: Specifications on how to configure and use Docker for the project.
- Folder Structure: Description of the organization of the project directories.
- Project Architecture: Explanation of the architecture used, including design patterns and technical decisions.
- Development Flow: Description of the development process adopted, including planning, coding, and review stages.
- Apache Camel Integration: Guide on integrating Apache Camel into the project, including configuration and usage.
- Contributors and Authors: Recognition of the contributors to the project.
- Contributions: Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
- Code of Conduct: Behavioral guidelines expected for the project community.
- OpenAPI Specification: Details about the OpenAPI specification used to document the API endpoints.
- API Documentation with Swagger: Information on how to access and use the interactive API documentation generated by Swagger.
- Javadoc Documentation: Information on the Javadoc documentation generated for the project.
- Endpoint Description: Details of the available API endpoints, including methods, parameters, and usage examples.
- Database Management: Strategies and practices for efficient management of the database used by the project.
- Testing Strategies: Approach and methods used to test the software, including unit, integration, and E2E tests.
- Testing Tools: Description of the testing tools used in the project and how to configure them.
- CI/CD Pipeline: Explanation of the continuous integration and delivery pipeline, detailing each stage and its function.
- Automations and Artifact Generation: Description of the automations incorporated into the CI/CD, including documentation generation and build artifacts.
- .gitignore, .editorconfig and project.properties: Utility of these files to maintain code consistency and quality.
- Maven Wrapper and application.properties: Explanation of how these files help standardize the development environment.
- .env File and Travis CI Settings: Use of these files to configure the environment and CI integrations.
- Code Standards and Security: Guidelines for maintaining code quality and security.
- Monitoring and Logging Practices: Recommended techniques for monitoring and logging in the project.
- Licensing.
- Terms of Use: Information about the terms and conditions for using the software.
- Future Plans: Discussion on functionalities and improvements considered for future versions of the project.
- Improvement Proposals: Space for the community to suggest and debate improvements and innovations.
- External Links and References: Additional resources and external documentation relevant to the project.
- Security Policy: Details on the supported versions, reporting vulnerabilities, and general security practices.