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

FINERACT-2023: Improve contributor's guide #3765

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

abhinav7sinha
Copy link
Contributor

Description

Describe the changes made and why they were made.

Ignore if these details are present on the associated Apache Fineract JIRA ticket.

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.

@abhinav7sinha abhinav7sinha force-pushed the FINERACT-2023/first-time-contributors-guide branch 5 times, most recently from b7ad988 to 16f38ac Compare March 3, 2024 15:23
@abhinav7sinha abhinav7sinha force-pushed the FINERACT-2023/first-time-contributors-guide branch from 16f38ac to 81f53db Compare March 3, 2024 23:40

* 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]
Copy link
Contributor

Choose a reason for hiding this comment

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

We cannot point to an external project

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@@ -0,0 +1,3 @@
= VIDEO DEMONSTRATION

Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is really old. Let's delete or create a new one. I think it should be a demo of the APIs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jdailey Done.

Copy link
Contributor

@jdailey jdailey left a comment

Choose a reason for hiding this comment

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

A few changes I think are needed.

@abhinav7sinha abhinav7sinha force-pushed the FINERACT-2023/first-time-contributors-guide branch from 6be8a8e to d34fcb5 Compare March 15, 2024 17:29
@abhinav7sinha abhinav7sinha force-pushed the FINERACT-2023/first-time-contributors-guide branch from d34fcb5 to 79d71e9 Compare March 15, 2024 17:34
@abhinav7sinha
Copy link
Contributor Author

A few changes I think are needed.

agreed. I've made the changes now

@adamsaghy
Copy link
Contributor

@abhinav7sinha Please fix the conflicts (rebase your PR) and squash the commits!

Copy link

github-actions bot commented May 4, 2024

This pull request seems to be stale. Are you still planning to work on it? We will automatically close it in 30 days.

@github-actions github-actions bot added the stale label May 4, 2024
@jdailey
Copy link
Contributor

jdailey commented Jun 21, 2024

Is this stale? What changes are needed to accept this?

@github-actions github-actions bot removed the stale label Sep 6, 2024
@Napho
Copy link
Contributor

Napho commented Sep 28, 2024

@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

Copy link

This pull request seems to be stale. Are you still planning to work on it? We will automatically close it in 30 days.

@github-actions github-actions bot added the stale label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants