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

docs: Refactored files and added installation guide #16

Merged
merged 3 commits into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
4. See an error

**Expected behavior**
A clear and concise description of what you expected to happen.
Expand All @@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Operating Environment:**
- Desktop, Cluster, Cloud, other
- OS, technology stack
- other

- Desktop, Cluster, Cloud, other
- OS, technology stack
- other

**Additional context**
Add any other context about the problem here.
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/communication-suggestion.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Communication Suggestion
about: 'Propose a way to better communicate a feature '
title: ''
labels: ''
assignees: ''

about: "Propose a way to better communicate a feature "
title: ""
labels: ""
assignees: ""
---

**Describe how we are communicating and why it is not optimal.**
Expand Down
13 changes: 6 additions & 7 deletions .github/ISSUE_TEMPLATE/documentation-update.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
---
name: Documentation Update
about: Suggest how we can improve our documentation
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**What does the current documentation state?**
Copy and paste the text currently in the documentation. If you want improve graphs or photos, please provide a screenshot of the original.
Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original.

**Where is this stated?**
Provide additional information about the location where you have copied the above statement from.

**Why do you want to improve the statement?**
Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc.
Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc.

**Proposed statement**
Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull-request.
Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request.

**Additional info**
Add any useful information here.
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand Down
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/science-contribution-and-review-.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
name: 'Science Contribution and Review '
name: "Science Contribution and Review "
about: Suggest how the science behind the code can be improved
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**Please describe the problem.**
A clear and concise description of what the problem is.
A clear and concise description of what the problem is.

**Describe the correct or improved scientific approach.**
A clear and concise description of what you want to happen.
Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/user-feedback.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: User Feedback
about: Describe how we can improve your experience
title: ''
labels: ''
assignees: ''

title: ""
labels: ""
assignees: ""
---

**Describe what you are trying to do and why it is not optimal.**
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Please describe the tests that you ran to verify your changes. Provide instructi
## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have performed a self-review of my code
- [ ] I have commented on my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have checked my code and corrected any misspellings
- [ ] I have tagged the reviewers in a comment below incase my pull request is ready for a review
- [ ] I have tagged the reviewers in a comment below in case my pull request is ready for a review
- [ ] I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

<!--- Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look --->
15 changes: 7 additions & 8 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
# Comment to be posted on first-time issues
newIssueWelcomeComment: |
Hello there!👋 Welcome to moja global!💖

Thank you and congratulations 🎉 for opening your very first issue in this project.
Moja global fosters an open and welcoming environment for al our contributors.🌸 Please adhere to our [Code Of Conduct](https://github.com/moja-global/About_moja_global/blob/master/CODE_OF_CONDUCT.md).
Moja global fosters an open and welcoming environment for all our contributors.🌸 Please adhere to our [Code Of Conduct](https://github.com/moja-global/About_moja_global/blob/master/CODE_OF_CONDUCT.md).

Incase you want to claim this issue, please comment down below!
Please checkout if any of the already existing issue template fits for your isssue or you may open a blank issue as well ✨
In case you want to claim this issue, please comment down below!
Please check out if any of the already existing issue templates fit your issue or you may open a blank issue as well ✨
We will try to get back to you as soon as we can.👀

Feel free to join us on [moja global Private Slack](https://mojaglobal.slack.com/) by dropping an email [here](mailto:info@moja.global).👩‍💻 We would love to hear your interesting ideas and engage in discussions.💖
Moja global is delighted to have you here :)

# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
# Comment to be posted to on PRs from first-time contributors in your repository
newPRWelcomeComment: |
Hello there!👋 Welcome to moja global!💖
Thank you and congrats 🎉 for opening your first PR on this project.✨
We will review it soon! Till then you can checkout the `README.md` for more details on it.
We will review it soon! Till then you can check out the `README.md` for more details on it.

Moja global fosters an open and welcoming environment for al our contributors.🌸 Please adhere to our [Code Of Conduct](https://github.com/moja-global/About_moja_global/blob/master/CODE_OF_CONDUCT.md).
Moja global fosters an open and welcoming environment for all our contributors.🌸 Please adhere to our [Code Of Conduct](https://github.com/moja-global/About_moja_global/blob/master/CODE_OF_CONDUCT.md).

Feel free to join us on [moja global Private Slack](https://mojaglobal.slack.com/) by dropping an email [here](mailto:info@moja.global).👩‍💻 We would love to hear your interesting ideas and engage in discussions.💖
Moja global is delighted to have you here :)
Expand All @@ -45,5 +45,4 @@ firstPRMergeComment: |
<p>Create a welcoming or beginner friendly issue for someone else! 😄 🎉 </p>
</details>


# It is recommended to include as many gifs and emojis as possible!
Loading