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

Improve the README.md and Enhanced Integration Tests #51

Open
wants to merge 18 commits into
base: dev
Choose a base branch
from

Conversation

wjuniorbh92
Copy link
Contributor

@wjuniorbh92 wjuniorbh92 commented Aug 24, 2023

  1. Introduction of Makefile:

    • A new Makefile has been added to streamline our development processes and commands. This addition is expected to improve the manageability of the project and reduce setup time for all contributors.
  2. Updated README:

    • The README file has been revamped to provide clearer instructions, context about the project, and guidelines for both new and returning developers. The documentation now offers a better perspective on the project's architecture and its core components.
  3. Enhanced Integration Tests:

    • We've refined our integration tests, ensuring they cover more edge cases and provide more comprehensive validation of our code's functionality. These improvements will further solidify our confidence in the system's reliability and readiness for production deployments.

Note to Reviewers:
I'd like to bring to your attention that there are some pending tests in this PR. The reason behind this is that we're anticipating future tasks that might introduce changes to the structure. As a result, these pending tests will be addressed once those changes are implemented.

@wjuniorbh92 wjuniorbh92 added the documentation Improvements or additions to documentation label Aug 24, 2023
@wjuniorbh92 wjuniorbh92 self-assigned this Aug 24, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@wjuniorbh92 wjuniorbh92 temporarily deployed to Production August 28, 2023 20:13 — with GitHub Actions Inactive
@wjuniorbh92 wjuniorbh92 temporarily deployed to Production August 31, 2023 11:14 — with GitHub Actions Inactive
@wjuniorbh92 wjuniorbh92 marked this pull request as ready for review August 31, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants