Skip to content

Commit

Permalink
Init base structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Potapy4 committed Sep 24, 2019
1 parent 0bc3619 commit ccb10cf
Show file tree
Hide file tree
Showing 24 changed files with 1,188 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"contributors": [],
"contributorsPerLine": 7,
"projectName": "Cake.Pnpm",
"projectOwner": "cake-contrib",
"repoType": "github",
"repoHost": "https://github.com"
}
44 changes: 44 additions & 0 deletions .appveyor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
image:
- Ubuntu
- Visual Studio 2017

pull_requests:
do_not_increment_build_number: true

skip_branch_with_pr: true

environment:
APPVEYOR_YML_DISABLE_PS_LINUX: true

branches:
only:
- master
- develop
- /release\/.*/
- /hotfix\/.*/

matrix:
fast_finish: true

test: off
build: off

build_script:
- ps: .\build.ps1 -Target AppVeyor
- sh: ./build.sh --target=AppVeyor

cache:
- "tools -> build.cake,tools/packages.config"

for:
- matrix:
only:
- image: Ubuntu
environment:
GITHUB_PASSWORD:
GITTER_TOKEN:
MYGET_API_KEY:
NUGET_API_KEY:
SLACK_TOKEN:
TWITTER_ACCESS_TOKEN:
WYAM_ACCESS_TOKEN:
38 changes: 38 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

# This may not be needed, but kept for compatibility with VS
[*.{sln,csproj}]
end_of_line = crlf

# Markdown files allows the use of trailing spaces to denote
# a line break
[*.md]
trim_trailing_whitespace = false

# Batch and powershell files requires crlf to be
# used as the line ending.
# Powershell also requires UTF-8 with BOM encoding
# to function if utf8 characters is used (maibe batch files as well)
[*.{bat,ps1}]
charset = utf-8-bom
end_of_line = crlf

# Shell scripts requires the use of lf line endings
# to be able to run.
[*.sh]
end_of_line = lf

[*.{yml,yaml}]
indent_size = 2

# The visual studio code file
# requires the use of crlf line endings
[tasks.json]
end_of_line = crlf
21 changes: 21 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
###############################################################################
# Set default behavior to automatically normalize line endings.
###############################################################################
* text=auto

*.cs text diff=csharp

*.ps1 text eol=crlf
*.bat text eol=crlf
*.sln text eol=crlf
*.csproj text eol=crlf
tasks.json text eol=crlf

*.sh text eol=lf

*.md text whitespace=-trailing-space

# Exclude files from exporting

.gitattributes export-ignore
.gitignore export-ignore
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
language: csharp
dist: xenial
os:
- linux
- osx
mono: latest
dotnet: 2.1.603

cache:
directories:
- tools

env:
global:
- DOTNET_CLI_TELEMETRY_OPTOUT: 1
- DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true

git:
depth: false

branches:
only:
- master
- develop
- /release\/.*/
- /hotfix\/.*/

script:
- ./build.sh
17 changes: 17 additions & 0 deletions .yo-rc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"generator-cake-addin": {
"promptValues": {
"projectName": "Pnpm",
"repositoryOwner": "Nikita Potapenko",
"projectMaintainer": "Potapy4",
"author": "Potapy4",
"description": "A wrapper around pnpm functionality within a Cake build script.",
"licenseType": "MIT",
"sourceDir": "./src",
"scriptName": "build.cake",
"enableAllContributors": true,
"enableWyam": true,
"enableTravis": true
}
}
}
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, 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.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

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

For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>
144 changes: 144 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Contributing to Cake.Pnpm

First and foremost, thank you! We appreciate that you want to contribute to Cake.Pnpm,
your time is valuable, and your contributions mean a lot to us.

## Table of Contents

- [Important](#important)
- [Getting started](#getting-started)
- [Issues](#issues)
- [Before creating an issue](#before-creating-an-issue)
- [Creating an issue](#creating-an-issue)
- [Closing issues](#closing-issues)
- [Next steps](#next-steps)

## Important

By contributing to this project, you:

- Agree that you have authored 100% of the content
- Agree that you have the necessary rights to the content
- Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
- Agree that the content you contribute may be provided under the Project license(s)
- Agree that, if you did not author 100% of the content,
the appropriate licenses and copyrights have been added along with any other necessary attribution.

## Getting started

**What does "contributing" mean?**
Creating an issue is the simplest form of contributing to a project.
But there are many ways to contribute, including the following:

- Updating or correcting documentation
- Feature requests
- Bug reports

If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing][idiomatic-contributing] has a lot of useful information.

**Showing support for Cake.Pnpm**
Please keep in mind that open source software is built by people like you,
who spend their free time creating things the rest of the community can use.

Don't have time to contribute? No worries, here are some other ways to show your support for Cake.Pnpm:

- star the [project][]
- tweet your support for Cake.Pnpm
- answer questions on [StackOverflow][]

## Issues

Please only create issues for bug reports or feature requests.
Issues discussing any other topics may be closed by the project's maintainers without further explanation.

Do not create issues about bumping dependencies unless a bug has been identified
and you can demonstrate that it effects this library.

**Help us to help you**
Remember that we’re here to help, but not to make guesses about what you need help with:

- Whatever bug or issue you're experiencing, assume that it will not be as obvious to the maintainers as it is to you.
- Spell it out completely. Keep in mind that maintainers need to think about _all potential use cases_ of a library.
It's important that you explain how you're using a library so that maintainers can make that connection
and solve the issue.

_It can't be understated how frustrating and draining it can be to maintainers to have to ask
clarifying questions on the most basic things,
before it's even possible to start debugging.
Please try to make the best use of everyone's time involved, including yourself,
by providing this information up front._

### Before creating an issue

Please try to determine if the issue is caused by an underlying library, and if so, create the issue there.
Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out.
Oftentimes the readme will have advice about where to go to create issues.

Try to follow these guidelines:

- **Avoid creating issues for implementation help** - It's much better for discoverability, SEO, and semantics -
to keep the issue tracker focused on bugs and feature requests -
to ask implementation-related questions on [stackoverflow.com][stackoverflow]
- **Investigate the issue** - Search for existing issues (open or closed) that address the issue, and might have even resolved it already.
- **Check the readme** - oftentimes you will find notes about creating issues,
and where to go depending on the type of issue.
- Create the issue in the appropriate repository.

### Creating an issue

Please be as descriptive as possible when creating an issue.
Give us the information we need to successfully answer your question or address your issue
by answering the following in your issue:

- **description**: (required) What is the bug you're experiencing? How are you using this library?
- **OS**: (required) What operating system are you on?
- **version**: (required) please note the version of Cake.Pnpm you are using
- **cake version**: (required) please note the version of Cake you are running your build script with
- **error messages**: (required) please paste any error messages into the issue,
or a [gist][] (you may also link to a failing build)
- **addins, etc**: (if applicable) please list any other addins you're using that may affect the Cake.Pnpm addin

### Closing issues

The original poster or the maintainers of Cake.Pnpm may close an issue at any time.
Typically, but not exclusively, issues are closed when:

- The issue is resolved, and will be released in the next version of Cake.Pnpm
- The project's maintainers have determined the issue is out of scope
- An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked.
- A discussion has clearly run its course

## Next steps

**Tips for creating idiomatic issues**
Spending just a little extra time to review best practices and brush up on your contributing skills will, at minimum,
make your issue easier to read, easier to resolve,
and more likely to be found by others who have the same or similar issue in the future.
At best, it will open up doors and potential career opportunities by helping you be at your best.

The following resources were hand-picked to help you be the most effective contributor you can be:

- The [Guide to Idiomatic Contributing][idiomatic-contributing] is a great place for newcomers to start,
but there is also information for experienced contributors there.
- Take some time to learn basic markdown. We can't stress this enough.
Don't start pasting code into GitHub issues before you've taken a moment to review this [markdown cheatsheet][md-cheatsheet]
- The GitHub guide to [basic markdown][basic-md] is another great markdown resource.
- Learn about [GitHub Flavored Markdown][gh-flavored-md].
And if you want to really go above and beyond,
read [mastering markdown][mastering-md].

At the very least, please try to:

- Use backticks to wrap code.
This ensures that it retains its formatting and isn't modified when it's rendered by GitHub,
and makes the code more readable to others
- When applicable, use syntax highlighting by adding the correct language name after the "code fence"

[basic-md]: https://help.github.com/articles/markdown-basics/
[gh-flavored-md]: https://help.github.com/articles/github-flavored-markdown/
[gist]: https://gist.github.com/
[idiomatic-contributing]: https://github.com/jonschlinkert/idiomatic-contributing
[mastering-md]: https://guides.github.com/features/mastering-markdown/
[md-cheatsheet]: https://gist.github.com/jonschlinkert/5854601
[project]: https://github.com/Nikita Potapenko/Cake.Pnpm
[stackoverflow]: https://stackoverflow.com/questions/tagged/cakebuild
Loading

0 comments on commit ccb10cf

Please sign in to comment.