You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by "abhinav7sinha (via GitHub)" <gi...@apache.org> on 2024/02/25 11:12:33 UTC
[PR] FINERACT-2023: Improve contributor's guide [fineract]
abhinav7sinha opened a new pull request, #3765:
URL: https://github.com/apache/fineract/pull/3765
## Description
Describe the changes made and why they were made.
Ignore if these details are present on the associated [Apache Fineract JIRA ticket](https://github.com/apache/fineract/pull/1284).
## Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
- [x] Write the commit message as per https://github.com/apache/fineract/#pull-requests
- [x] 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.
- [x] Create/update unit or integration tests for verifying the changes made.
- [x] Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.
- [x] 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
- [x] 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on PR #3765:
URL: https://github.com/apache/fineract/pull/3765#issuecomment-2034400965
@abhinav7sinha Please fix the conflicts (rebase your PR) and squash the commits!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "abhinav7sinha (via GitHub)" <gi...@apache.org>.
abhinav7sinha commented on code in PR #3765:
URL: https://github.com/apache/fineract/pull/3765#discussion_r1526623533
##########
fineract-doc/src/docs/en/chapters/contributing/contributing.adoc:
##########
@@ -0,0 +1,55 @@
+= Getting Started Guide
+
+Fineract is maintained by a large group of contributors, just like you! Getting started with a mature platform like Fineract can be daunting for new contributors. This guide will help you through your first contribution!
+
+== Read FAQ
+** First, have a look at the FAQ on our Wiki link:https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327[here]
+** Is this Mifos?
+*** The Mifos Initiative, contributed the code that forms the basis of fineract, and it remains involved with a number of front end implementations and other systems that run "on top of" fineract, including a payment hub and API management. Many of the developers are on both listservs. However, Mifos as a separate non-Apache entity is not part of the project as it is considered a "vendor".
+
+== Communication Channels
+
+** Join our Slack Community and subscribe to our Mailing lists.
+*** link:mailto:dev-subscribe@fineract.apache.org[Apache Fineract Developers List]: Send a blank email to dev-subscribe@fineract.apache.org
+*** link:https://the-asf.slack.com/archives/C4QPZURQQ[Apache Fineract Slack Channel]
+*** link:https://bit.ly/mifos-slack[Mifos Slack Channel]: There's an active community of developers on the Mifos Slack channel, and you may consider joining it.
+
+== Communication Guidelines
+
+The Apache Software Foundation (ASF) adage is: *"If it didn't happen on the list, then it didn't happen."*
+
+All communications that happen off-list should be brought back to the list. Normally, you should not discuss things off list, but if you do, then you should summarize it on list.
+
+Example, if you discuss something "off list" on a slack channel, especially one at Mifos slack, then you should summarize that discussion on the dev list (dev@fineract.apache.org). By summarizing it, you are bringing into the official record of the project.
+
+== Dev environment setup:
+
+Follow link:../development/dev-env-setup.adoc[these] steps to set up your dev environment.
+
+== Identify something to work on
+
+* Browse existing link:https://issues.apache.org/jira/browse/FINERACT-2055?jql=project%20%3D%20FINERACT%20ORDER%20BY%20created%20DESC[issues]
+** Filter by tags - "volunteer", "gsoc", "new contributor", etc.
+* Browse link:https://mifosforge.jira.com/wiki/spaces/RES/pages/3532095546/Google+Summer+of+Code+2024+Ideas[GSoC projects]
Review Comment:
Done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "abhinav7sinha (via GitHub)" <gi...@apache.org>.
abhinav7sinha commented on code in PR #3765:
URL: https://github.com/apache/fineract/pull/3765#discussion_r1526623324
##########
fineract-doc/src/docs/en/chapters/demos/video-demonstration.adoc:
##########
@@ -0,0 +1,3 @@
+= VIDEO DEMONSTRATION
+
+Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo>
Review Comment:
@jdailey Done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "jdailey (via GitHub)" <gi...@apache.org>.
jdailey commented on code in PR #3765:
URL: https://github.com/apache/fineract/pull/3765#discussion_r1521788166
##########
fineract-doc/src/docs/en/chapters/demos/video-demonstration.adoc:
##########
@@ -0,0 +1,3 @@
+= VIDEO DEMONSTRATION
+
+Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo>
Review Comment:
This is really old. Let's delete or create a new one. I think it should be a demo of the APIs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #3765:
URL: https://github.com/apache/fineract/pull/3765#issuecomment-2442915273
This pull request seems to be stale. Are you still planning to work on it? We will automatically close it in 30 days.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #3765: FINERACT-2023: Improve contributor's guide
URL: https://github.com/apache/fineract/pull/3765
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #3765:
URL: https://github.com/apache/fineract/pull/3765#issuecomment-2093906446
This pull request seems to be stale. Are you still planning to work on it? We will automatically close it in 30 days.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "Napho (via GitHub)" <gi...@apache.org>.
Napho commented on PR #3765:
URL: https://github.com/apache/fineract/pull/3765#issuecomment-2380549557
@abhinav7sinha is this something that you are still open to finishing, I am looking to make contributions to the documentation mainly finishing the TBD sections and i think a lot of the work is already done here. If you are open to someone else taking over these changes and getting them in please let me know
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "abhinav7sinha (via GitHub)" <gi...@apache.org>.
abhinav7sinha commented on PR #3765:
URL: https://github.com/apache/fineract/pull/3765#issuecomment-2000134778
> A few changes I think are needed.
agreed. I've made the changes now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2023: Improve contributor's guide [fineract]
Posted by "jdailey (via GitHub)" <gi...@apache.org>.
jdailey commented on code in PR #3765:
URL: https://github.com/apache/fineract/pull/3765#discussion_r1521786440
##########
fineract-doc/src/docs/en/chapters/contributing/contributing.adoc:
##########
@@ -0,0 +1,55 @@
+= Getting Started Guide
+
+Fineract is maintained by a large group of contributors, just like you! Getting started with a mature platform like Fineract can be daunting for new contributors. This guide will help you through your first contribution!
+
+== Read FAQ
+** First, have a look at the FAQ on our Wiki link:https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327[here]
+** Is this Mifos?
+*** The Mifos Initiative, contributed the code that forms the basis of fineract, and it remains involved with a number of front end implementations and other systems that run "on top of" fineract, including a payment hub and API management. Many of the developers are on both listservs. However, Mifos as a separate non-Apache entity is not part of the project as it is considered a "vendor".
+
+== Communication Channels
+
+** Join our Slack Community and subscribe to our Mailing lists.
+*** link:mailto:dev-subscribe@fineract.apache.org[Apache Fineract Developers List]: Send a blank email to dev-subscribe@fineract.apache.org
+*** link:https://the-asf.slack.com/archives/C4QPZURQQ[Apache Fineract Slack Channel]
+*** link:https://bit.ly/mifos-slack[Mifos Slack Channel]: There's an active community of developers on the Mifos Slack channel, and you may consider joining it.
+
+== Communication Guidelines
+
+The Apache Software Foundation (ASF) adage is: *"If it didn't happen on the list, then it didn't happen."*
+
+All communications that happen off-list should be brought back to the list. Normally, you should not discuss things off list, but if you do, then you should summarize it on list.
+
+Example, if you discuss something "off list" on a slack channel, especially one at Mifos slack, then you should summarize that discussion on the dev list (dev@fineract.apache.org). By summarizing it, you are bringing into the official record of the project.
+
+== Dev environment setup:
+
+Follow link:../development/dev-env-setup.adoc[these] steps to set up your dev environment.
+
+== Identify something to work on
+
+* Browse existing link:https://issues.apache.org/jira/browse/FINERACT-2055?jql=project%20%3D%20FINERACT%20ORDER%20BY%20created%20DESC[issues]
+** Filter by tags - "volunteer", "gsoc", "new contributor", etc.
+* Browse link:https://mifosforge.jira.com/wiki/spaces/RES/pages/3532095546/Google+Summer+of+Code+2024+Ideas[GSoC projects]
Review Comment:
We cannot point to an external project
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org