Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Deadlyelder authored Jan 24, 2024
0 parents commit f3171ce
Show file tree
Hide file tree
Showing 9 changed files with 240 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
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

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
25 changes: 25 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Trigger Jenkins Pipe

on:
push:
branches:
- main

jobs:
trigger-a-jenkins-job:
runs-on: ubuntu-latest

steps:
- name: Trigger Jenkins Pip
id: triggerjenkinsjob
run: |
JENKINS_SERVER="${{ secrets.JENKINS_SERVER }}"
JENKINS_JOB="${{ secrets.JENKINS_PROJECT }}"
JENKINS_USERNAME="${{ secrets.JENKINS_USERNAME }}"
JENKINS_TOKEN="${{ secrets.JENKINS_PAT }}"
# Fetch Jenkins build status using GitHub API
STATUS=$(curl -s -u "${JENKINS_USERNAME}:${JENKINS_TOKEN}" "${JENKINS_SERVER}/job/${JENKINS_JOB}/lastBuild/api/json" | jq -r '.result')
# Output Jenkins build status
echo "Jenkins Build Status: ${STATUS}"
3 changes: 3 additions & 0 deletions CODE OF CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CODE OF CONDUCT.md
The code of conduct is being define by the hackathon governance/policy workstream.
It will be updated in the future.
73 changes: 73 additions & 0 deletions CODING STYLE GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# CODING STYLE GUIDELINES.md

### 1. Code Formatting

- Use consistent indentation throughout your code examples. Typically, two or four spaces are recommended for each level of indentation.
- Follow the language's conventions for naming variables, functions, classes, and modules.
- Maintain a consistent naming style, such as camelCase, snake_case, or PascalCase, depending on the language's conventions.
- Use meaningful variable and function names that describe their purpose.
- Use proper spacing around operators and punctuation to enhance readability.

### 2. Comments

- Include comments to explain the purpose and functionality of code segments.
- Use clear and concise comments. Avoid excessive comments that merely repeat the code.
- Comment any non-obvious or complex parts of the code to help readers understand the logic.
- Ensure comments are up-to-date. Update comments when you modify code.

### 3. Code Clarity

- Keep code examples concise and focused on the specific topic or concept you're demonstrating.
- Avoid unnecessarily complex code or language features that could confuse readers.
- Break long code examples into smaller, digestible sections or steps, and provide explanations as necessary.
- Highlight important lines of code or key takeaways using comments or inline explanations.

### 4. Error Handling

- Include error handling and show how to handle common errors gracefully when applicable.
- Explain any error messages or exceptions that may occur and how to troubleshoot them.

### 5. Usage of Variables

- Declare variables before using them, and ensure they are initialized if required.
- Highlight variable assignments and their significance in your explanations.

### 6. Consistency

- Be consistent with coding conventions, such as naming, formatting, and style, throughout your code examples.
- Use a consistent approach for importing libraries, modules, or dependencies.
- Maintain a consistent file structure and organization in your examples.

### 7. Language-Specific Guidelines

- Follow language-specific best practices and guidelines for code examples.
- Use idiomatic code constructs and patterns for the specific programming language.

### 8. Testing

- Whenever possible, include testing or verification steps to ensure the code examples work as expected.
- Encourage readers to test the code on their own systems and report any issues.

### 9. Version Compatibility

- Specify the version(s) of the programming language, libraries, or frameworks your code examples are compatible with.
- Mention any breaking changes or differences between versions if relevant.

### 10. Licensing and Attribution

- Include a clear statement about the licensing terms for your code examples.
- Attribute the source if the code is adapted from external sources or open-source projects.

### 11. Examples Organization

- Organize your code examples logically, grouping related examples together.
- Provide a clear structure for code files, such as headers, imports, main code blocks, and comments.

### 12. Platform Independence

- Ensure that code examples are platform-independent whenever possible.
- Specify any platform-specific instructions or dependencies if needed.

### 13. Updates and Maintenance

- Periodically review and update your code examples to keep them relevant and in line with the latest best practices.
17 changes: 17 additions & 0 deletions COPYING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# COPYING.md
Info about the license used is still under discussion, subject to change and to be validated at a later stage.
At this stage, the most probable license will be BSDv3. Any changes towards the rights of the contributors will be duly conveyed.

# BSDv3

Copyright 2024 ICRC Delegation for Cyberspace

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46 changes: 46 additions & 0 deletions Jenkinsfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
pipeline {
agent any
stages {
stage('Static Analysis') {
steps {
echo 'Run the static analysis to the code'
}
}
stage('Compile') {
steps {
echo 'Compile the source code'
}
}
stage('Security Check') {
steps {
echo 'Run the security check against the application'
}
}
stage('Run Unit Tests') {
steps {
echo 'Run unit tests from the source code'
}
}
stage('Run Integration Tests') {
steps {
echo 'Run only crucial integration tests from the source code'
}
}
stage('Publish Artifacts') {
steps {
echo 'Save the assemblies generated from the compilation'
}
}
}
post {
always {
script {
if (env.CHANGE_ID) {
githubStatus context: 'continuous-integration/jenkins', state: 'success'
githubComment message: "The pipeline completed successfully!"
githubLabel labels: ['approved']
}
}
}
}
}
2 changes: 2 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# LICENSE.md
<<PLACEHOLDER>>
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Template Repository
[![License: BSD3](https://img.shields.io/badge/License-BSD3-blue.svg)](https://opensource.org/license/bsd-3-clause/)

[![Trigger Jenkins Pipe](https://github.com/digitharium/template_repo_hackathon/actions/workflows/main.yml/badge.svg)](https://github.com/digitharium/template_repo_hackathon/actions/workflows/main.yml) <<CHANGE ME

## Introduction
This repository is a template for all the repositories that will be used at the hackathon 2024 part of the symposium.

## Contributors
* Contributor 1
* Contributor 2
* ...

## Instructions
This section will highlight the instructions needed for this repository

0 comments on commit f3171ce

Please sign in to comment.