Fineract 2081: Enhance technical documentation #4077
Conversation
fineract-doc/src/docs/en/chapters/appendix/properties-resilience4j.adoc
Outdated
Show resolved
Hide resolved
Napho
force-pushed
the
FINERACT-2081/enhance_technical_documentation
branch
from
9984684
to
4996607
Compare
|
@Napho please also filll the ticket description as expected. Thank you |
|
@Napho Please amend the commit message to fit for the required format: After the Fineract jira ticket there should be a colon and after the short description. The actual description is misleading: "FINERACT-2081 add descriptions to property file values" |
Napho
force-pushed
the
FINERACT-2081/enhance_technical_documentation
branch
from
4996607
to
533cfce
Compare
Napho
force-pushed
the
FINERACT-2081/enhance_technical_documentation
branch
from
533cfce
to
85acd3f
Compare
@adamsaghy thanks for that, ive updated it accordingly |
sorry @Napho, but the correct commit message format is |
adamsaghy
changed the title
Description
Describe the changes made and why they were made.
Descriptions have been added to property file value documentation in fineract-doc module
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
Write the commit message as per https://github.com/apache/fineract/#pull-requests
Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
Create/update unit or integration tests for verifying the changes made.
Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.
Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)
FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.