Merge pull request #40 from mxochicale/38-templates-and-few-other-bits

38 - templates and few other bits

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, 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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+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 opening a [new issue](https://github.com/mxochicale/tools/issues/new/choose). 
+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
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: "\U0001F41B Bug Report"
+about: If you are pretty sure you are getting a bug, please create a report to help us improve this work
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+
+### 🐛Bug
+<!-- A clear and concise description of what the bug is. Please use a short, concise title for the bug and elaborate here -->
+
+
+### To reproduce
+
+<!-- What did you do? -->
+<!-- Please provide a minimal working example, if possible: https://stackoverflow.com/help/minimal-reproducible-example -->
+
+```python
+# Your code here
+```
+
+### Expected behavior
+
+<!-- What did you expect? -->
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Actual behavior
+
+<!-- What did you get? -->
+<!-- A clear and concise description of what actually happens. -->
+<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
+
+```python-traceback
+# Paste the whole error stack trace here
+```
+
+### System info
+
+Output of your application
+
+```
+# Paste here the output of that command in a terminal
+```

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "\U0001F680 Feature Request"
+about: Submit a proposal/request for a new feature
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+### 🚀 Feature
+<!-- A clear and concise description of the feature proposal -->
+
+### Motivation
+<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
+
+### Pitch
+<!-- A clear and concise description of what you want to happen. -->
+
+### Alternatives
+<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
+
+### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/not_working.md

@@ -0,0 +1,44 @@
+---
+name: "\U00002757 Something is not working"
+about: If something is not working as expected but you're not sure if it's a bug, please follow the instructions in this template.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+
+### Problem
+<!-- A clear and concise description of what the bug is. Please use a short, concise title for the bug and elaborate here -->
+
+
+### To reproduce
+<!-- What did you do? -->
+<!-- Please provide a minimal working example, if possible: -->
+<!-- https://stackoverflow.com/help/minimal-reproducible-example -->
+<!-- Here's another useful resource: "How To Ask Questions The Smart Way" -->
+<!-- http://www.catb.org/~esr/faqs/smart-questions.html -->
+
+```python
+# Your code here
+```
+
+### Expected behavior
+<!-- What did you expect? -->
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Actual behavior
+<!-- What did you get? -->
+<!-- A clear and concise description of what actually happens. -->
+<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
+
+```python-traceback
+# Paste the *full* error stack trace here
+```
+
+### System info
+Output of application
+
+```
+# Paste here the output of that command in a terminal
+```

.github/pull_request_template.md

@@ -0,0 +1,38 @@
+<!-- Replace {issue_number} with the issue that will be closed after merging this PR -->
+## Description
+Fixes #{issue_number}: A few sentences describing the changes proposed in this pull request.
+
+## Type of change
+Please delete options accordingly to the description.
+
+<!-- Write an `x` in all the boxes that apply -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+
+### Suggested Checklist
+<!-- You do not need to complete all the items by the time you submit the pull request, but most likely the changes will only be merged if all the tasks are done. -->
+
+<!-- Write an `x` in all the boxes that apply -->
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation 
+- [ ] My changes generate no new warnings 
+- [ ] I have commented my code, particularly in hard-to-understand areas 
+- [ ] I have read the [`CONTRIBUTING`](https://github.com/mxochicale/tools/blob/main/CONTRIBUTING.md) docs
+- [ ] My code passes, following the style guidelines `pre-commit run -a` 
+- [ ] My code is properly tested with `pytest -sv tests`
+- [ ] This pull request is ready to be reviewed
+- [ ] Make sure your branch is up-to-date with main branch. See below a general example if `rebase` is need.
+```
+git checkout main
+git pull origin main
+git checkout FEATURE_BRANCH 
+git rebase main
+#git status
+#edit conflicting files with your editor
+#git rebase --continue
+#git add .
+git push --force origin FEATURE_BRANCH
+```

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to `mxochicale/tools`.
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+When contributing to this repository, please first discuss the change you wish to make via issue, instant message in clara-agx chatbox, or any other method with the owners of this repository before making a change. 
+Please note we have a [code of conduct](.github/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## :octocat: Setting up project locally. 
+1. Generate your SSH keys as suggested [here](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
+2. Clone the repository by typing (or copying) the following lines in a terminal
+```
+git clone [email protected]:mxochicale/tools.git
+```
+
+## New issues
+* Open an issue (bug report, feature request, or something is not working): https://github.com/mxochicale/tools/issues/new/choose 
+* Workflow for issue management 
+```mermaid
+  flowchart TD;
+      Z[Bug Reported] -->A[...];  
+      A[Bug resolution] -->B(Testing OK?);
+      B--Yes-->C[Prepare commit];
+      B--No-->D[Reopen issue];
+      D----> A[Bug resolution];
+      C ----> E[Request Review];
+      E ----> F[Commit changes];
+      F --> H[Merge PR and close issue]
+```  
+
+## Committing and pushing changes 
+1. Clone this repo 
+```
+git clone [email protected]:mxochicale/tools.git
+``` 
+2. Create new branch using issue number
+```
+git checkout -b ISSUENUMBER-branch-name 
+```
+3. Commit changes and push to your branch
+```
+git add .
+git commit -m 'short message (#ISSUENUMBER)'
+git push origin ISSUENUMBER-branch-name
+```
+4. Submit a Pull Request against the `main` branch. 
+
+## Pull Request (PR) and merge to `main` branch
+1. Select branch that contain your commits.
+2. Click `Compare and pull request` and create PR for the associated branch.
+3. Type a title and description of your PR and create PR
+4. Please keep your PR in sync with the base branch.
+```
+git checkout main
+git pull origin main
+git checkout RB 
+git rebase main
+git push --force origin RB
+```
+5. Run `pre-commit` to tidy up code and documentation (see next section). 
+6. Request a PR review.
+See [collaborating-with-pull-requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) for further details.
+7. Once your PRs has been approved, procced to merge it to main. See [Merging a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)
+8. Remove your merged branch from your repo and in the list of https://github.com/mxochicale/tools/branches
+```
+#Local git clear
+git branch --merged | grep -v '\*\|master\|main\|develop' | xargs -n 1 git branch -d
+#Remote git clear
+git branch -r --merged | grep -v '\*\|master\|main\|develop' | sed 's/origin\///' | xargs -n 1 git push --delete origin
+```
+
+