Skip to content

Commit 7a67509

Browse files
FoxliderFoxlider
committed
Professionals Have Standards
Professionals Have Standards https://user-images.githubusercontent.com/19773387/159466938-81088002-bde0-4a7d-8a29-1c73f9ada497.gif
1 parent e795a99 commit 7a67509

7 files changed

+252
-12
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,28 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
**Describe the bug**
1111
A clear and concise description of what the bug is.
1212

13-
**To Reproduce**
13+
**To Reproduce**
1414
Steps to reproduce the behaviour:
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behaviour**
20+
**Expected behaviour**
2121
A clear and concise description of what you expected to happen.
2222

23-
**Actual behaviour**
23+
**Actual behaviour**
2424
A clear and concise description of what actually happened.
2525

26-
**Screenshots**
26+
**Screenshots**
2727
If applicable, add screenshots to help explain your problem.
2828

29-
**OS Version (required):**
29+
**OS Version (required):**
3030
- OS: [e.g. Windows 10 1903]
31-
- Version [e.g. 1.1a]
31+
- FASTER Version [e.g. 1.8b]
3232

33-
**Additional context**
33+
**Additional context**
3434
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ assignees: ''
77

88
---
99

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

13-
**Describe the solution you'd like**
13+
**Describe the solution you'd like**
1414
A clear and concise description of what you want to happen.
1515

16-
**Describe alternatives you've considered**
16+
**Describe alternatives you've considered**
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

19-
**Additional context**
19+
**Additional context**
2020
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Motivation and Context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
9+
10+
## How Has This Been Tested?
11+
<!--- Please describe in detail how you tested your changes. -->
12+
<!--- Include details of your testing environment, and the tests you ran to -->
13+
<!--- see how your change affects other areas of the code, etc. -->
14+
15+
## Screenshots (if appropriate):
16+
17+
## Types of changes
18+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
19+
- [ ] Bug fix (non-breaking change which fixes an issue)
20+
- [ ] New feature (non-breaking change which adds functionality)
21+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
22+
23+
## Checklist:
24+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
25+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
26+
- [ ] My code follows the code style of this project.
27+
- [ ] My change requires a change to the documentation.
28+
- [ ] I have updated the documentation accordingly.
29+
- [ ] I have read the **CONTRIBUTING** document.

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -328,3 +328,7 @@ ASALocalRun/
328328

329329
# MFractors (Xamarin productivity tool) working folder
330330
.mfractor/
331+
332+
333+
# VS Code User Files
334+
.vscode/

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement on
63+
[Discord](https://discord.gg/2BUuZa3).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to FASTER
2+
3+
A big welcome and thank you for considering contributing to FASTER! It’s people like you that make it a reality for users in our community.
4+
5+
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
6+
7+
## Quicklinks
8+
9+
* [Code of Conduct](#code-of-conduct)
10+
* [Getting Started](#getting-started)
11+
* [Issues](#issues)
12+
* [Pull Requests](#pull-requests)
13+
* [Getting Help](#getting-help)
14+
15+
## Code of Conduct
16+
17+
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/Foxlider/FASTER/blob/master/CODE-OF-CONDUCT.md).
18+
19+
## Getting Started
20+
21+
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
22+
23+
- Search for existing Issues and PRs before creating your own.
24+
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
25+
26+
### Issues
27+
28+
Issues should be used to report problems with the program, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
29+
30+
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help by indicating to our maintainers that a particular problem is affecting more than just the reporter.
31+
32+
### Pull Requests
33+
34+
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
35+
36+
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
37+
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
38+
- Address a single concern in the least number of changed lines as possible.
39+
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
40+
41+
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
42+
43+
In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
44+
While a bit different, it is generally the same idea.
45+
46+
1. Fork the repository to your own Github account
47+
2. Clone the project to your machine
48+
3. Create a branch locally with a succinct but descriptive name. It is preferred to branch from the current update branch that should be named feature/Update-X.Y
49+
4. Commit changes to the branch
50+
5. Following any formatting and testing guidelines specific to this repo
51+
6. Push changes to your fork
52+
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
53+
54+
The changes will be added to the version when the current update is merged back with the master.
55+
56+
## Getting Help
57+
58+
Join us in the [FASTER Community](https://discord.gg/2BUuZa3) and post your question there in the correct category with a descriptive tag.

‎SECURITY.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
FASTER Supported Versions.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| < 1.6x | :x: |
10+
| 1.7x | :warning: |
11+
| 1.8x | :heavy_check_mark: |
12+
13+
> :x: : Not supported
14+
> :heavy_check_mark: : Supported
15+
> :warning: : Only Critical Updates
16+
17+
18+
## Reporting a Vulnerability
19+
20+
1.7 and previous versions have a vulnerability with Steam Passwords being encrypted with a weaker Cypher than the one used in 1.8.
21+
It is not critical but updating to a more recent version is recommended.

0 commit comments

Comments
 (0)