Skip to content

Commit

Permalink
Added repository information files
Browse files Browse the repository at this point in the history
  • Loading branch information
craftersmine committed Aug 29, 2023
1 parent 0befe95 commit 92c2fe0
Show file tree
Hide file tree
Showing 8 changed files with 278 additions and 0 deletions.
Binary file added .github/AppPreview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github:
patreon:
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: craftersmine
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
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: "[BUG] Bug report"
labels: bug
assignees: ''

---

---
name: Bug report
about: Create a report to help us improve

---

**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 tell as much as you can/want/know):**
- OS: [e.g. Windows 10 Home]
- .NET version [e.g. v6.0]
- Application version

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

---

---
name: Feature request
about: Suggest an idea for this project

---

**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.
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
rodion.morozov.01@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.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

So, you want to help improve this app? That is fantastic, you are a _wonderful_ person, thank you! Given that I this is a
spare-time project, I can use all the help I can get.

## Bugs and Feature Requests
1. Report bugs in the [Issues](https://github.com/craftersmine/BaldursGate3.SaveManager/issues) section. Please explain your bugs as best you can. The best way is to write steps-to-reproduce (STR) which explains step by step how to make the bug happen. Bugs without such a reproduction might not be fixable. If your bug is a crash, please include a logs of your application or stacktraces.

2. Ask for features in the [Issues](https://github.com/craftersmine/BaldursGate3.SaveManager/issues) section too. Keep in mind that while I personally cannot add everything - I have to constrain my own workload around features I myself will have a use for - perhaps there's another kind person who will be able to add it?

3. Give _productive_ feedback. Read the [Code of Conduct](https://github.com/craftersmine/BaldursGate3.SaveManager/blob/master/CODE_OF_CONDUCT.md) and adhere to it. Remember I'm not selling you anything, I don't owe you anything. Whether you use my product is completely up to you. Meaning; if you're rude your post will quite simply be ignored.

## Pull Requests
Since I cannot possibly do everything myself, I will certainly accept pull requests - but I must ask that you follow a few ground rules. This is so I can keep control of the repository, and to help prevent you wasting your time on work that I will reject.

1. **Remember that many users will be inexperienced both with IDEs and coding**. It's very important that your feature is easy to use.

2. Please _ask me_ before starting work on a larger contribution. I have the final say in what I want added. I can tell you if what you want to add will be rejected outright and I really don't want you to waste your time, it's too valuable for me. You can either ask via an [Issue](https://github.com/craftersmine/BaldursGate3.SaveManager/issues).

3. I recommend not trying to do a pull request unless you already have a bit of experience in coding. This isn't any kind of requirement though, if your addition isn't too large you might get some help finishing.

4. Remember that I will have to review your work. Anything you can do to help that process will be appreciated.

5. Expect criticism.

6. Read the [Code of Conduct](https://github.com/craftersmine/BaldursGate3.SaveManager/blob/master/CODE_OF_CONDUCT.md) and adhere to it.
26 changes: 26 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)

What does this implement/fix? Explain your changes.
---------------------------------------------------

Does this close any currently open issues?
------------------------------------------


Any relevant logs, error output, etc?
-------------------------------------
(If it’s long, please paste to https://ghostbin.com/ or https://pastebin.com/ and insert the link here.)

Any other comments?
-------------------

Where has this been tested?
---------------------------
**Operating System:**

**Platform:**

**Application version:**
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# BaldursGate3.SaveManager
Save manager for Larian Studios' game Baldur's Gate 3

[![GitHub](https://img.shields.io/github/license/craftersmine/BaldursGate3.SaveManager?color=darklime)](/LICENSE)
[![GitHub Releases](https://img.shields.io/github/downloads/craftersmine/BaldursGate3.SaveManager/total?label=github%20downloads&logo=github)](https://github.com/craftersmine/BaldursGate3.SaveManager/releases)
![Discord](https://img.shields.io/badge/discord-craftersmine-5865f2?logo=discord&logoColor=white)
![GitHub Repo stars](https://img.shields.io/github/stars/craftersmine/BaldursGate3.SaveManager)
![Maintenance](https://img.shields.io/maintenance/yes/2023)

![Repository Preview](https://raw.githubusercontent.com/craftersmine/BaldursGate3.SaveManager/master/.github/AppPreview.png)

## Supports:
* Previewing saves with screenshot and some info
* Archiving all or selected saves into ZIP archive
* Deleting selected saves (both in bulk or one-by-one)

## Installation:
* **THE APP REQUIRES .NET 6!** You can download it [here](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-6.0.20-windows-x64-installer)
* Download latest application archive [here](https://github.com/craftersmine/BaldursGate3.SaveManager/releases)
* Extract in whatever folder your soul wants
* Launch `craftersmine.BaldursGate3.SaveManager.exe` executable

0 comments on commit 92c2fe0

Please sign in to comment.