Merge pull request #12 from stratosphereips/feature_repository-genera…

…l-improvements

Feature repository general improvements

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behaviour if applicable. Be brief but make sure it can be reproduced. Bullet points are welcomed here.
+
+**Expected behaviour**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behaviour if applicable. Be brief but make sure it can be reproduced. Bullet points are welcomed here.
+
+**Expected behaviour**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.

.github/docs/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+Thank you for taking the time to contribute to this project. All contributions are welcomed! 
+
+## How can you contribute?
+
+* Report bugs
+* Suggest features and ideas
+* Pull requests with a solved GitHub issue and a new feature
+* Pull request with new content.
+
+## Persistent Git Branches
+
+The following git branches are permanent in the repository:
+
+- `main`: contains the stable version of the repository. All new features should be based on this branch.
+
+## Naming Git branches for Pull Requests
+
+To keep the Git history clean and facilitate the revision of contributions we 
+ask all branches to follow concise namings. These are the branch-naming patterns
+to follow when contributing:
+
+- bugfix-<>: pull request branch, contains one bugfix,
+- docs-<>: pull request branch, contains documentation work,
+- enhance-<>: pull request branch, contains one enhancement (not a new feature, but improvement nonetheless)
+- feature-<>: pull request branch, contains a new feature,
+- refactor-<>: pull request branch, contains code refactoring,
+
+## What branch should you base your contribution?
+
+As a general rule, base your contribution on the `main` branch.
+
+## Creating a pull request
+
+Commits:
+- Commits should do one thing. Keep it simple.
+- Commit messages should be easily readable, in imperative style ("Fix memory leak in...", not "FixES mem...")
+
+Pull Requests:
+- If you have developed multiple features and/or bugfixes, create separate
+ branches for each one of them, and request merges for each branch;
+- The cleaner your code/change/changeset is, the faster it will be merged.

.github/docs/pull_request_template.md

@@ -0,0 +1,30 @@
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] 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
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings

.github/workflows/autotag.yml

@@ -0,0 +1,36 @@
+name: Auto Tag
+on:
+ push:
+ branches:
+ - main
+jobs:
+ Patch:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: '0'
+ - name: Minor version for each merge
+ id: taggerDryRun
+ uses: anothrNick/[email protected]
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ WITH_V: true
+ DRY_RUN: true
+
+ - name: echo new tag
+ run: |
+ echo "The next tag version will be: ${{ steps.taggerDryRun.outputs.new_tag }}"
+ - name: echo tag
+ run: |
+ echo "The current tag is: ${{ steps.taggerDryRun.outputs.tag }}"
+ - name: echo part
+ run: |
+ echo "The version increment was: ${{ steps.taggerDryRun.outputs.part }}"
+
+ - name: Minor version for each merge
+ id: taggerFinal
+ uses: anothrNick/[email protected]
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ WITH_V: true

Dockerfile

@@ -1,6 +1,11 @@
 FROM python:3.9-slim
 
-LABEL org.opencontainers.image.authors="[email protected],[email protected]"
+LABEL org.opencontainers.image.title="Zeek Anomaly Detector" \
+ org.opencontainers.image.description="This image runs the Zeek Anomaly Detector tool for network data analysis." \
+ org.opencontainers.image.version="0.1.0" \
+ org.opencontainers.image.created="2023-07-27" \
+ org.opencontainers.image.source="https://github.com/stratosphereips/zeek_anomaly_detector" \
+ org.opencontainers.image.authors="Veronica Valeros <[email protected]>, Sebastian Garcia <[email protected]>"
 
 ENV DEBIAN_FRONTEND=noninteractive
 ENV DESTINATION_DIR /zeek_anomaly_detector/