Skip to content

Commit

Permalink
init(init first release)
Browse files Browse the repository at this point in the history
  • Loading branch information
ololx committed Apr 2, 2020
1 parent 4163e87 commit d3add20
Show file tree
Hide file tree
Showing 16 changed files with 1,329 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.workflow linguist-vendored=true
*.workflow linguist-language=Automator
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# all hidden files
.*

#exclude
!.gitignore
!.gitattributes
40 changes: 40 additions & 0 deletions BADGES_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Badges Guide

This section presents a some badges reference guide from the [readme](README.md) file, which are project activity info and are not widely distributed or are attached special for this project.

## Status

Status is an informational badge which shows the project development activity. This information can be represented by the following statuses:

- `active` - this means that the project is under active development.
- `frozen` - this means that the project is still under development, but all work on it was temporarily suspended to clarify and formalize new ideas.
- `completed` - this means that the project implements the intended functionality and the development is completed. Development can be resumed if new ideas for an improvements or features appear.

If you want to help in development, you have any feature suggestions for the project or if you faced a problem or bug, please visit the [contributing](CONTRIBUTING.md) section.

## Version

This information represents the actual version of the project. For the versioning is used [SemVer](http://semver.org/).

## OSS Lifecycle

OSS Lifecycle is an initiative started by Netflix to classify open-source projects into lifecycles and clearly identify which projects are active and which ones are retired. To enable this badge, simply create an `OSSMETADATA` tagging file at the root of your GitHub repository containing a single line similar to the following: `osslifecycle=active`. Other suggested values are `osslifecycle=maintenance` and `osslifecycle=archived`. A working example can be viewed on the [OSS Tracker repository](https://github.com/Netflix/osstracker).

## Maintenance

This is an informational badge which shows the maintenance process state of the project. The following statuses are applied:

- `yes` - this means that the project is under maintenance.
- `no (of {expiration date})` - this means that the project is no longer maintained.

In both cases, the project can still be used.

Please visit the [contributing](CONTRIBUTING.md) page if you faced with some issues with the project.

## Release Date

This is an information about the project release date which would be stable and could be used. In this case, it is possible to indicate the date of the first release, last release, release of a specific version.

## Commit Date

This is an information about the project commit date, which would show the last commit date in the project repository.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.0.0] - 2020-03-01]

### Added
- The mac Automator workflow which allows to:
- automate the symbolic links creation;
- create symbolic links for the selected files or folders;
- save symbolic links to the selected directory.
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
ololx@icloud.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
116 changes: 116 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Contributing

🎉 If you want to contribute this project thanks for taking the time on it and wish you to have fun.

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note this repository have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Contributing Factors

### 🐞 Did you find a bug?

- Ensure the bug was not already reported by searching on GitHub under **Issues**.
- If you're unable to find an open issue addressing the problem, open a **new one**. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Provide test images, which can be used for reproducing.

#### Bug Report Template

For the creating **Issues**, please see this template.

----

| name | about | title | labels | assignees |
| :--------: | :--------------------------------: | :---: | :----: | --------: |
| Bug report | 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 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.

----

### 🩹 Did you write a patch that fixes a bug?

- Open a new GitHub **pull request** with the patch.

- Ensure the **pull request** description clearly describes the problem and solution. Include the relevant issue number if applicable.

### 🎈 Did you fix whitespace, format code, or make a purely cosmetic patch?

- Changes that are cosmetic in nature and do not add anything substantial to the stability,
functionality, or testability of this project - you are welcome.

### ⚙️ Do you intend to add a new feature or change an existing one?

- Suggest your change in the **feature request** and wait for approval to avoid writing code, which won't be added.
- Do not open a **pull request** on GitHub until you have collected positive feedback about the change.

#### Feature Request Template

For the creating **feature request**, please see this template.

----

| name | about | title | labels | assignees |
| :-------------: | :------------------------------: | :---: | :----: | --------: |
| Feature request | 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.

----

## Pull Request Process

1. Update the [readme](README.md) file and [changelog](#CHANGELOG.md) file with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
2. Increase the version numbers in any examples files, the [readme](README.md) file, the [changelog](#CHANGELOG.md) file, and also badges (if it is needed) to the new version that this **pull request** would represent. For the versioning is used [Semantic Versioning](http://semver.org/).
3. You may merge the **pull request** in once you have the sign-off of one or more other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

### Pull Request Checklist

For any pull request, please refer to this checklist.

----

- [ ] Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
- [ ] Make sure you are making a pull request against the **master branch** (left side).
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
- [ ] Check your code additions will fail neither code linting checks nor unit test.

----
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
1 change: 1 addition & 0 deletions OSSMETADATA
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
osslifecycle=maintenance
Loading

0 comments on commit d3add20

Please sign in to comment.