Abhinav - Great initiative and much needed. The Apache Software Foundation (ASF) adage is: "If it didn't happen on the list, then it didn't happen."
if you're going to point to a slack channel, remember to point to the Apache Fineract channel ==> https://the-asf.slack.com/archives/C4QPZURQQ and, just as a reminder, all communications that happen off-list should be brought back to the list, including ASF slack discussion. 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 here at Dev@fineract.a.o. By summarizing it, you are bringing into the official record of the project. In terms of content: I think that the readme file has some useful "getting started" info confused with "using it regularly" info. I think a clear separation of those two scenarios is useful. thanks On Sat, Feb 24, 2024 at 5:03 AM Abhinav Sinha <abhinav7.si...@gmail.com> wrote: > Hi, > > > > I am working on a new contributors guide for the Fineract project. > > > > The idea is pretty straightforward – it’s going to be the first link any > new contributor to Apache Fineract can visit, and it will have everything > they need to get started. > > > > We have a lot of good documentation scattered across READMEs, > docs.mifos.org, etc. I am trying to collate the ones needed for > first-time contributors in one place. Here > <https://github.com/abhinav7sinha/fineract/blob/FINERACT-2023/first-time-contributors-guide/contributors/guide/contributing.md> > is the initial draft currently on GitHub, we can move it to a different > place. > > > > Fineract’s README on GitHub is pretty good and has a lot of this > information. The new contributor’s guide will link to this README, but it > will have any additional info that a new contributor could be looking for > (a high-level overview of the contribution process, GSoC links, etc.) > > > > I am looking for any ideas that you may have on this guide, or any > documentation-related suggestions that you feel we can improve on. I also > want to take this opportunity to clean up the existing README, so anything > that you feel is missing, or needs change, pls let me know. > > > > Additionally, new contributors to Fineract - if you are facing any > difficulty with getting the right information, feel free to share, I would > love to hear your opinion/ideas. > > > > Thanks, > > Abhinav >
