Reorganize project structure to re-align with best practices

[RenanCarlosPereira]

Summary: Reorganized the project files to follow standard conventions by moving them into dedicated directories: src, tests, and docs.

Changes:

1. Source Files:
   • Moved all main code files to the src directory.
2. Test Files:
   • Moved all test files to the tests directory.
3. Documentation:
   • Moved all documentation files to the docs directory.
4. Benchmark:
   • Moved all Benchmarks files to the benchmark directory.

Reason for Changes:

1. Standardization:
   • Following Microsoft's recommended project structure for better maintainability and readability.
2. Community Best Practices:
   • Aligning with common open-source project structures as described in Folder Structure Conventions.

Benefits:

• Improved Organization: Clear separation of source code, tests, and documentation.
• Easier Navigation: Simplifies finding and managing different parts of the project.
• Better Collaboration: Makes it easier for new contributors to understand the project structure.

please note the open issue #7

@asulwer could you review it?

[asulwer]

what is the purpose for the global.json?

[RenanCarlosPereira]

what is the purpose for the global.json?

The global.json file in a .NET project serves several important purposes:

1. SDK Version Specification:

   • It specifies which version of the .NET SDK should be used when building the project. This ensures that the project is built with a specific SDK version, providing consistency across different development environments and CI/CD pipelines.

2. Roll Forward Policies:

   • It allows configuration of roll forward policies, such as using the latest patch version, the latest minor version, or the latest feature version. This flexibility helps manage SDK updates and ensures compatibility without unexpected breaks.

3. Multi-Targeting:

   • In solutions with multiple projects, global.json can be used to specify a single SDK version for the entire solution. This avoids conflicts and inconsistencies when different projects target different versions of the SDK.

4. Prerelease Versions:

   • The allowPrerelease setting can control whether prerelease versions of the SDK should be considered. This is useful for testing and adopting new features before they are officially released.

5. Tools and Workloads:

   • It can also specify additional tools and workloads that should be used with the project, ensuring all necessary components are available and correctly versioned.

Key Elements Explained

• "sdk": This section contains settings related to the .NET SDK.
  • "version": The base SDK version that should be used. The specified version will be the minimum required, and roll forward policies can adjust the exact version used.
  • "rollForward": Controls how the SDK version is selected if the exact specified version is not available. Possible values include:
  • "patch": Roll forward to the latest patch version.
  • "feature": Roll forward to the latest feature version.
  • "minor": Roll forward to the latest minor version.
  • "major": Roll forward to the latest major version.
  • "disable": Do not roll forward; use the exact specified version.
  • "allowPrerelease": Determines whether prerelease versions of the SDK can be used. If set to true, prerelease versions will be considered when selecting the SDK version.

Benefits

• Consistency: Ensures all developers and build systems use the same SDK version, reducing "it works on my machine" issues.
• Compatibility: Helps manage dependencies and compatibility by controlling SDK updates.
• Control: Provides control over which SDK features and updates are used in the project, allowing for a managed and predictable development environment.

Overall, global.json is a powerful tool for managing .NET SDK versions and ensuring a consistent and predictable development and build environment.