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

Add: Basic files of sample source code repository #1

Merged
merged 5 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
6 changes: 6 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Contributing to this project

If you want to contribute this project, please send pull request to **main** branch.
**DO NOT** send pull request to other branches.

https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/tree/main/
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These are supported funding model platforms

patreon: ColoryGames
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug
about: Use this template for reporting a bug.
title: ''
labels: bug
assignees: ''

---

**System Information**

* OS: [e.g. Windows]
* UEFN version: [e.g. 5.0.0]
* Sample version: [e.g. 1.0.0]

**Expected behavior**
*The behavior you expect about the feature you reported.*

**Description about the bug**
*The description about the bug.*

**Screenshots/Logs** [Optional]
*It is good to solve the bug if you attach screenshots or logs (like crash report).*

**Additional comments** [Optional]
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature Request
about: Use this template for feature request.
title: ''
labels: enhancement
assignees: ''

---

**Description about the feature**
*The description about the feature. It is good to clear who will benefit with this feature.*

**Are you willing to contribute about this feature. (Yes/No)**

**Screenshots** [Optional]
*It is good to understand the features if you attach the screenshots.*

**Additional comments** [Optional]
22 changes: 22 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Lint

on:
workflow_dispatch:
push:
branches:
- main
- ci_testing
pull_request:

jobs:
crlf-check:
name: crlf-check
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Check CRLF
uses: erclu/check-crlf@v1
with:
path: .
57 changes: 57 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Release

on:
push:
branches:
- main
tags:
- 'v*'
pull_request:

jobs:
sample-pack:
name: Pack sample sources
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v2

- name: Compress sample project's sources
run: |
mkdir release-sample
zip -r Samples.zip Samples
mv Samples.zip release-sample

- name: Upload artifact
uses: actions/upload-artifact@v2
with:
name: Samples
path: "release-sample"

publish:
name: Publish
needs: [sample-pack]
if: startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v2
- name: Fetch Artifacts
uses: actions/download-artifact@v2
with:
path: dist
- name: Install hub command
run: |
sudo apt update
sudo apt install -y hub
- name: Create Release
env:
GITHUB_TOKEN: ${{ secrets.TOKEN_FOR_ACTIONS }}
run: |
set -x
assets=()
for asset in dist/Samples/*.zip; do
assets+=("-a" "$asset")
done
tag_name="${GITHUB_REF##*/}"
hub release create "${assets[@]}" -m "$tag_name" "$tag_name"
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Change Log

## [Unreleased](https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/compare/v1.0.0...main)

## [Version 1.0.0](https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/compare/3f68bf18ca2ce179e420cc5562c7fa3b6c6e1bd4...v1.0.0) - 2024.3.12

Release for First Edition (Version 1.0).
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
colory.games.contact@gmail.com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# LetsLearnUEFN-VerseForBeginners-Samples
Sample Programs for "Let's Learn UEFN - Verse for Beginners"
# Sample Programs for "Let's Learn UEFN - Verse for Beginners"

This repository contains the sample programs for ["Let's Learn UEFN - Verse for Beginners"](https://www.amazon.com/dp/B0CW1FVJ13).

## How to use the sample programs

### Requirements

To use the sample programs, following softwares must be installed on your Windows PC.

* UEFN v28.20 or later
* Visual Studio Code

### Usage

1. Move to a [release page](https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/releases) related to a book's edition.
|Book's Edition|Release Page|
|---|---|
|First Edition|[Version 1.0](https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/releases/tag/v1.0.0)|

1. Download `Samples.zip` and unzip it.

## Change Log

See [CHANGELOG.md](CHANGELOG.md).

## Report Bug, Discussion

If you find a bug in the sample program, you can report it at [Issue](https://github.com/colory-games/LetsLearnUEFN-VerseForBeginners-Samples/issues) or [Discord](https://discord.gg/F9cRxfAuJd).
Loading