Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements to Project Configuration and Documentation #1

Merged
merged 9 commits into from
Mar 2, 2024

Conversation

carlosiborra
Copy link
Owner

Pull Request Title:

Enhancements to Project Configuration and Documentation

Pull Request Description:

This pull request introduces several significant updates to improve the project's configuration, security, and documentation. These changes are aimed at streamlining development workflows, enhancing code quality, and securing sensitive information. Below is a detailed overview of the modifications included in this pull request:

Configuration and Quality Enhancements:

  • Added .gitignore: A comprehensive .gitignore file has been introduced to exclude unnecessary files from the repository, such as build outputs and IDE-specific files, ensuring a cleaner project structure. (@DaniFdz)
  • Fixed .gitignore: Subsequent adjustments were made to the .gitignore file to ensure its effectiveness in ignoring the correct files and directories. (@DaniFdz)
  • Added .editorconfig: To promote code consistency across various editors and IDEs, an .editorconfig file has been added. This helps maintain uniform coding styles for all contributors. (@DaniFdz)

Continuous Integration and Security Improvements:

  • Added CI to Pull Requests on Every Branch: Continuous Integration (CI) has been set up to run automated tests and checks on pull requests for every branch, helping to catch issues early and improve code quality. (@DaniFdz)
  • Added Secrets to .gitignore and Removed obj Folder: Secrets and the obj folder have been added to .gitignore to enhance security and maintain the repository's cleanliness. Additionally, the existing obj folder has been deleted from the repository. (@DaniFdz)

Documentation Updates:

  • Added Documentation for Secrets File: Detailed documentation has been added to guide contributors on how to handle secrets within the project securely. (@DaniFdz)
  • Update README.md: The project's README file has been updated to reflect the latest changes and provide up-to-date information for new contributors. (@carlosiborra)

@carlosiborra carlosiborra merged commit 2c94021 into main Mar 2, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants