Abhinav created FINERACT-2023:
---------------------------------
Summary: Improve First-time contributors guide
Key: FINERACT-2023
URL: https://issues.apache.org/jira/browse/FINERACT-2023
Project: Apache Fineract
Issue Type: Improvement
Reporter: Abhinav
*From:* Ed Cable <[email protected]>
*Date:* Tuesday, November 14, 2023 at 1:56 PM
*To:* Abhinav Sinha <[email protected]>, Avinaash M Vijayvargiya
<[email protected]>
*Subject:* Re: Task: Improve our First-Time Contributors Guide
It should also link to some of the key sections (especially architectural and
functional overviews) in our ASCII docs -
[https://fineract.apache.org/docs/current/]
In terms of audience for this page it wouldn't just be a new GSOC contributor
but any first-time contributor even if they're somewhat experienced with OSS -
i.e. any type I get a volunteer who wants to contribute to back-end, I'd like
to simply send them the link to this page and this shoudl fully orient them to
learn what software does, where we need contribution, who they contribute, how
to get environment set up and be able to make their first successful
contribution/PR.
Ed
On Tue, Nov 14, 2023 at 10:53 AM Ed Cable
<[[email protected]|mailto:[email protected]]> wrote:
Hi Abhinav,
I know Aleks was soon going to reach out with next set of tasks but he's been
pretty busy with the release. One thing that I think would be super helpful to
work on in the meantime would be a proper GSOC/new contributor guide that we
could link to from Mifos wiki - it could be primarily for Fineract/back-end but
it could also include web-app.
We can build off of what we have as contribution/guideline/readme but this
first-time contributor guide should be pretty simple steps and then link to all
the main key areas.
Basically it should include:
# Why they should contribute
# How to get development environment set up
# Cleaning up and improving holes in our documentation as needed.
# Standards for contributions/process for contributing
# Best practices, etc.
# Where and How they should contribute
# High level of how
# Link to the appropriate JIRA fliters which have issues tagged with
"volunteer", "gsoc", "new contributor", etc.
# Any other relevant how-to/s documentation/
# Link to stuff like Chirag's previous contribution guide here:
[https://docs.mifos.org/general-contributing-guidelines/contributors-guide] or
incorporate stuff from there too.
# Where to contact mentors or get help on project
# Slack
# Mailing Lists
# Include link to GSOC ideas/application page.
[@Avinaash M Vijayvargiya|mailto:[email protected]] would you like to
work on the same for our mobile apps?
You can references other first time contributor guides which I think can be
access for a bunch of projects from here:
[https://firstcontributions.github.io/]
I once came across a really good first time contributor page but for life of me
can't find it :(
--
*Ed Cable*
{quote} {quote}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
