CBSNexora/cbsnexora
4
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #2391 from steinwinde/doc

Browse Source 
docs: Update CONTRIBUTING, README
This commit is contained in:
David Higgins
2025-04-11 15:17:23 +01:00
committed by GitHub
parent 3c22b71d6e 1bc7b59097
commit 26f37e6a53
3 changed files with 57 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CODE_OF_CONDUCT.md
-46
View File
@@ -1,46 +0,0 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@mifos.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
.github/CONTRIBUTING.md → CONTRIBUTING.md
+38 -36
View File
@@ -1,42 +1,44 @@
# Getting Started
- View the [README](../README.md) or [watch this video](https://youtu.be/OnxxC3K2oro) to get your development environment up and running.
- View the [README](./README.md) or [watch this video](https://youtu.be/OnxxC3K2oro) to get your development environment up and running.
- Learn how to [format pull requests](#submitting-a-pull-request).
- Read how to [rebase/merge upstream branches](#configuring-remotes).
- Understand our [commit message conventions](https://github.com/openMF/web-app/blob/master/.github/COMMIT_MESSAGE.md).
- Understand our [commit message conventions](./.github/COMMIT_MESSAGE.md).
- Sign our [Mifos CLA](http://mifos.org/about-us/financial-legal/mifos-contributor-agreement/).
- Follow our [code of conduct](CODE_OF_CONDUCT.md).
- [Find an issue to work on](https://github.com/openMF/web-app/issues) and start smashing!
- [Ask a question on Gitter](https://gitter.im/openMF/web-app).
- Follow our [code of conduct](https://mifos.org/resources/community/code-of-conduct/).
- [Find a Jira ticket to work on](https://mifosforge.jira.com/browse/WEB) and start smashing!
- [Ask a question on Slack](https://app.slack.com/client/T0F5GHE8Y/CJJGJLN10).
- Learn more at our [getting started guide](https://mifosforge.jira.com/wiki/spaces/RES/pages/464322561/New+Contributor+Getting+Started+Guide).
- Have a look at our [Wiki](https://github.com/openMF/web-app/wiki).
# Contributing Guidelines [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/openMF/web-app/issues)
Please outline the change you wish to make via a Jira ticket _before_ you start contributing. And please do not create Jira tickets for general support questions, as we want to keep Jira for bug reports and feature requests. If you have got any questions, the quickest way to get an answer is to join the above Slack channel. You can also write an email on our [mailing list](https://sourceforge.net/projects/mifos/lists/mifos-developer). Mifos has quite a few active repositories, and each has its own Slack channel to direct questions to.
When contributing to this repository, please first discuss the change you wish to make via an issue.
Make sure you read the [Wiki](https://github.com/openMF/web-app/wiki).
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. If you have got any questions, please email to our [mailing list](https://sourceforge.net/projects/mifos/lists/mifos-developer). You can also join our [gitter channel](https://gitter.im/openMF/web-app) to chat about your queries in real-time.
Each active repository has its own channel to direct questions to. Also join the [official gitter channel](https://gitter.im/openMF/mifos) of Mifos.
Remember that this is an inclusive community, committed to creating a safe, positive environment. See the whole [Code of Conduct](CODE_OF_CONDUCT.md) and please follow it in all your interactions with the project.
Mifos is an inclusive community, committed to creating a safe, positive environment. Read the above Code of Conduct, and please follow it in all your interactions with the project.
## Submitting or Requesting an Issue/Enhancement
### Best Practices for reporting or requesting for Issues/Enhancements:
- Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
- Follow the Issue Template while creating the issue.
- Include Screenshots if any (specially for UI related issues).
- For UI enhancements or workflows, include mockups to get a clear idea.
- Before you submit an issue, please search Jira. Maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available.
- Include screenshots if any (specially for UI related issues).
- For UI enhancements include mockups to provide a clear idea to the reader.
### Best Practices for getting assigned to work on an Issue/Enhancement:
- If you would like to work on an issue, inform in the issue ticket by commenting on it.
- If you would like to work on an issue, make sure it is not assigned to someone else.
- If you don't work on a Jira ticket, please unassign yourself.
- Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator.
**Note:** Please do not work on an issue which is already being worked on by another contributor. We don't encourage creating multiple pull requests for the same issue. Also, please allow the assigned person at least 2 days to work on the issue (The time might vary depending on the difficulty). If there is no progress after the deadline, please comment on the issue asking the contributor whether he/she is still working on it. If there is no reply, then feel free to work on the issue.
**Note:** Please do not work on an issue which is assigned to someone else. We don't encourage creating multiple pull requests for the same issue. Also, please allow the assigned person at least 3 days to work on an issue. If there is no progress after this deadline, comment on the issue asking the contributor whether he/she is still working on it. Only if there is no reply after a couple of days, assign the ticket to you and work on it.
### Jira ticket life cycle
- To Do: The issue is not prioritized yet. Make sure it make sense working on it by asking in Slack.
- On Deck: The issue can be worked on, but work hasn't been started. Often the issue has already someone assigned to it.
- In Progress: The issue is being worked on.
- In Review: There is a Pull Request on GitHub or the ticket is on hold, because someone needs to review made changes.
- Done: The Pull Request got merged on GitHub.
- Canceled: The ticket is unnecessary and for some reason (probably in the comments) work on it became unnecessary.
## Submitting a Pull Request
@@ -49,10 +51,10 @@ Remember that this is an inclusive community, committed to creating a safe, posi
git clone https://github.com/your-username/web-app.git
```
- Make sure you are in the `master` branch.
- Make sure you are in the `main` branch.
```
git checkout master
git checkout main
```
- Create a new branch with a meaningful name before adding and committing your changes.
@@ -67,7 +69,7 @@ git checkout -b branch-name
git add file-name
```
- Follow the style conventions for a [meaningful commit message](COMMIT_MESSAGE.md).
- Follow the style conventions for a [meaningful commit message](./.github/COMMIT_MESSAGE.md).
```
git commit
@@ -97,9 +99,9 @@ git push origin branch-name
git push origin remote-branch-name --force
```
- Follow the Pull request template and submit a pull request with a motive for your change and the method you used to achieve it to be merged with the `master` branch.
- Follow the Pull request template and submit a pull request with a motive for your change and the method you used to achieve it to be merged with the `main` branch.
- If you can, please submit the pull request with the fix or improvements including tests.
- During review, if you are requested to make changes, rebase your branch and squash the multiple commits into one. Once you push these changes the pull request will edit automatically.
- During review, if you are requested to make changes, rebase your branch and squash the multiple commits into one again. Once you push these changes, the pull request will edit automatically.
## Configuring remotes
@@ -120,18 +122,18 @@ git remote add upstream https://github.com/openMF/web-app.git
> upstream https://github.com/openMF/web-app.git (push)
```
3. To update your local copy with remote changes, run the following: (This will give you an exact copy of the current remote. You should not have any local changes on your master branch, if you do, use rebase instead.)
3. To update your local copy with remote changes, run the following: (This will give you an exact copy of the current remote. You should not have any local changes on your main branch, if you do, use rebase instead.)
```
git fetch upstream
git checkout master
git merge upstream/master
git checkout main
git merge upstream/main
```
4. Push these merged changes to the master branch on your fork. Ensure to pull in upstream changes regularly to keep your forked repository up to date.
4. Push these merged changes to the main branch on your fork. Ensure to pull in upstream changes regularly to keep your forked repository up to date.
```
git push origin master
git push origin main
```
5. Switch to the branch you are using for some piece of work.
@@ -143,7 +145,7 @@ git checkout branch-name
6. Rebase your branch, which means, take in all latest changes and replay your work in the branch on top of this - this produces cleaner versions/history.
```
git rebase master
git rebase main
```
7. Push the final changes when you're ready.
@@ -162,10 +164,10 @@ After your pull request is merged, you can safely delete your branch and pull th
git push origin --delete branch-name
```
2. Checkout the master branch.
2. Checkout the main branch.
```
git checkout master
git checkout main
```
3. Delete the local branch.
@@ -174,10 +176,10 @@ git checkout master
git branch -D branch-name
```
4. Update your master branch with the latest upstream version.
4. Update your main branch with the latest upstream version.
```
git pull upstream master
git pull upstream main
```
## Skipping a Travis CI Build
README.md
+19 -8
View File
@@ -2,7 +2,7 @@
## Overview
Mifos X Web App is a modern Single-Page Application (SPA) built on top of the Mifos X platform for financial inclusion. It's the revamped version of the Mifos X Community App, serving as the default web interface for the Mifos User Community.
Mifos X Web App is a modern single-page application (SPA) built on top of the Mifos X platform for financial inclusion. It serves as the default web interface for the Mifos user community.
**Technologies Used:**
@@ -16,8 +16,8 @@ Mifos X Web App is a modern Single-Page Application (SPA) built on top of the Mi
- [GitHub Repository](https://github.com/openMF/web-app)
- [TestRigor](https://app.testrigor.com/public/X3THbQd9nxLMxkdPu)
- [Slack Channel](https://app.slack.com/client/T0F5GHE8Y/CJJGJLN10)
- [Jira Board](https://mifosforge.jira.com/jira/your-work)
- [Jira Web App Project](https://mifosforge.jira.com/jira/software/c/projects/WEB/boards/62)
- [Jira Board of Mifos](https://mifosforge.jira.com/jira/your-work)
- [Jira Board of Mifos Web App Project](https://mifosforge.jira.com/jira/software/c/projects/WEB/boards/62)
## Installation Guide
@@ -40,8 +40,7 @@ Before installing the web app, you need to set up the Fineract backend server:
- **Option B: Install local Fineract server**
- For Windows: [Installation Guide](https://cwiki.apache.org/confluence/display/FINERACT/Fineract-platform+Installation+on+Windows)
- For Ubuntu: [Installation Guide](https://cwiki.apache.org/confluence/display/FINERACT/Fineract+Installation+on+Ubuntu+Server)
[Installation Guide](https://github.com/apache/fineract?tab=readme-ov-file#instructions-how-to-run-for-local-development)
- **Option C: Docker Compose for full stack**
- See Docker Compose section below for one-step backend+frontend setup
@@ -53,7 +52,7 @@ Before installing the web app, you need to set up the Fineract backend server:
### Frontend Setup (Web App)
Choose ONE of these methods to install the web app:
Choose ONE of the following methods to install the web app:
#### Method 1: Manual Installation
@@ -191,10 +190,22 @@ Available languages:
For more detailed configuration options, refer to the `env.sample` file in the root directory of the project.
## Releases
### 1.0.0 (Tag: 1.0.0-fineract1.11)
This is the first official release of the Mifos X web application:
- Developed for Fineract 1.11
- No Self Service area
- GLIM support limited
- JLG not yet supported
- Surveys not yet supported
## Contributing
We welcome contributions! Please read our [contribution guidelines](.github/CONTRIBUTING.md) before submitting pull requests.
We welcome contributions! Please read our [contribution guidelines](./CONTRIBUTING.md) before submitting pull requests.
## Related Projects
[Apache Fineract](https://github.com/apache/fineract) - Apache Fineract provides open APIs and affordable core banking solution for financial institutions and it is the backend for all UIs of the Mifos.
[Apache Fineract](https://github.com/apache/fineract) - Apache Fineract provides open APIs and affordable core banking solution for financial institutions and is the backend for all UIs of the Mifos.