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

Updated The READ.me File #97

Merged
merged 4 commits into from
Aug 29, 2024
Merged

Updated The READ.me File #97

merged 4 commits into from
Aug 29, 2024

Conversation

ManojLL
Copy link
Contributor

@ManojLL ManojLL commented Aug 15, 2024

Description of what I changed

Updated the READ.me file of the module

Issue I worked on

see https://openmrs.atlassian.net/browse/FLAG-

Checklist: I completed these to help reviewers :)

  • My IDE is configured to follow the code style of this project.

    No? Unsure? -> configure your IDE, format the code and add the changes with git add . && git commit --amend

  • I have added tests to cover my changes. (If you refactored
    existing code that was well tested you do not have to add tests)

    No? -> write tests and add them to this commit git add . && git commit --amend

  • I ran mvn clean package right before creating this pull request and
    added all formatting changes to my commit.

    No? -> execute above command

  • All new and existing tests passed.

    No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.

  • My pull request is based on the latest changes of the master branch.

    No? Unsure? -> execute command git pull --rebase upstream master

README.md Outdated
Developer Guide
---------------

#### Setup Project
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets use a ordered list for these steps

README.md Outdated

build the project

`mvn clean istall` in the root module package
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"install"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

READ.me file updated

README.md Outdated
* Maven
#### Setup Project

1. clone the project
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Clone"

README.md Outdated
`git clone https://github.com/<username>/openmrs-module-patientflags.git
`

2. build the project
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Build"

README.md Outdated

Provides a mechanism for marking patient records with important messages within OpenMRS
The openMRS Patient Flag Module provides the functionality to generate warning flags /
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenMRS


1. Clone the project

`git clone https://github.com/<username>/openmrs-module-patientflags.git
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's ask them to fork the repo first

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added fork step

@wikumChamith wikumChamith merged commit 598b2f2 into openmrs:master Aug 29, 2024
3 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