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

feat: github improvments, check if server.js exists #193

Closed
wants to merge 2 commits into from
Closed
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
125 changes: 125 additions & 0 deletions .github/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# 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

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.
40 changes: 40 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributing to Pacquet

Thank you for your interest in contributing to Pacquet! We welcome contributions from anyone who wants to help improve the project.

## How to Contribute

There are many ways you can contribute to Pacquet:

- **Report bugs or suggest features.** If you find a bug or have an idea for a new feature, please [open an issue](https://github.com/pnpm/pacquet/issues/new) on our GitHub repository. Be sure to provide as much detail as possible, so we can understand and reproduce the issue.

- **Submit code changes.** If you have fixed a bug or implemented a new feature, you can submit a [pull request](https://github.com/pnpm/pacquet/pulls) with your changes. Please follow our [code style guidelines](#code-style-guidelines) and make sure all tests pass before submitting your pull request.

- **Improve documentation.** Good documentation is essential for any project. If you see an opportunity to improve our documentation, whether it's fixing a typo or adding a new section, please submit a pull request with your changes.

## Code Style Guidelines

We follow the [Rust Style Guide](https://doc.rust-lang.org/1.0.0/style/README.html) for all code contributions. Please make sure your code follows these guidelines before submitting a pull request.

## Code of Conduct

We expect all contributors to follow our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing to the project.

Thank you again for your interest in contributing to Pacquet! We look forward to working with you.

# Setup

Pacquet uses [Cargo](https://doc.rust-lang.org/cargo/) to manage dependencies and build the project. To get started, install Cargo by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).

1. Fork this repository
2. Clone your forked repository
3. Make and test your changes
4. Create a pull request and wait for it to be reviewed

# Pull Requests

When you create a pull request, please make sure it meets the following requirements:

- The code follows [Rust Style Guide](https://doc.rust-lang.org/1.0.0/style/README.html)
- The pull request has a descriptive title and description
- The pull request is linked to an issue (if applicable)
62 changes: 62 additions & 0 deletions .github/issue_template/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: 🐛 Bug Report
description: Something isn't working
title: "[Bug]: "
labels: ["🐛 Type: Bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: "Is there an existing issue for this?"
description: "Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options:
- label: "I have searched the existing issues"
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the issue here.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true

- type: textarea
validations:
required: true
attributes:
label: "Expected behavior"
description: "A clear and concise description of what you expected to happened (or code)"

- type: textarea
attributes:
label: "Steps to reproduce"
description: |
What steps can we follow to reproduce the issue?
placeholder: |
1. `cargo install`
2. `cargo run add chalk`
3. See error...

- type: dropdown
id: operating-systems
attributes:
label: What type of Operating System are you seeing the problem on?
multiple: true
options:
- Linux
- Windows
- Mac
- Other
validations:
required: true

- type: textarea
id: logs
attributes:
label: Code to produce this issue.
description: Please copy and paste any relevant code to re-produce this issue.
19 changes: 19 additions & 0 deletions .github/issue_template/2-docs-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 📚 Documentation or README.md issue report
description: Report an issue in the project's documentation or README.md file.
title: "[Docs]: "
labels: ["💾 Type: Docs"]
body:
- type: textarea
id: describe-the-bug
attributes:
label: What happened?
description: Describe the issue here.
value: "A bug happened!"
validations:
required: true
- type: textarea
validations:
required: true
attributes:
label: "Expected behavior"
description: "A clear and concise description of what you expected to happened (or code)"
52 changes: 52 additions & 0 deletions .github/issue_template/3-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: 🚀 Feature Request
description: Suggest an idea or possible new feature for this project.
title: "[Feature Request]: "
labels: ["🚀 Type: Feature"]
body:
- type: checkboxes
attributes:
label: "Is there an existing issue for this?"
description: "Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options:
- label: "I have searched the existing issues"
required: true
- type: textarea
id: related-to-issue
attributes:
label: Related to issue?
description: Is your feature request related to a problem? Please describe.
value: "..."
validations:
required: true
- type: textarea
id: describe-the-feature
attributes:
label: Describe the feature
description: Describe the feature you'd like to see implemented.
value: "..."
validations:
required: true
- type: textarea
id: describe-the-solution
attributes:
label: Describe the solution you'd like
description: Describe the solution you'd like to see implemented.
value: "..."
validations:
required: true
- type: textarea
id: describe-alternatives
attributes:
label: Describe alternatives you've considered
description: Describe any alternative solutions or features you've considered.
value: "..."
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the feature request here.
value: "..."
validations:
required: true
44 changes: 44 additions & 0 deletions .github/issue_template/4-enhancement-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: ⭐ Enhancement
description: Suggest an enhancement for this project. Improve an existing feature.
title: "[Feature Request]: "
labels: ["⭐ Type: Enhancement"]
body:
- type: checkboxes
attributes:
label: "Is there an existing issue for this?"
description: "Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options:
- label: "I have searched the existing issues"
required: true
- type: textarea
id: related-to-issue
attributes:
label: Related to issue?
description: Is your feature request related to a problem? Please describe.
value: "..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution
description: Describe the solution you'd like to see implemented.
value: "..."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Describe any alternative solutions or features you've considered.
value: "..."
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the feature request here.
value: "..."
validations:
required: true
45 changes: 45 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## Checklist

- [ ] The commit message follows our [guidelines](contributing.md) and [Rust Style Guide](https://doc.rust-lang.org/1.0.0/style/README.html)
- [ ] Tests for the changes have been added and they all pass (or there are no tests required)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] The code has been formatted

## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [ ] Bugfix
- [ ] Feature
- [ ] Docs
- [ ] Formatting
- [ ] Refactoring
- [ ] Tests
- [ ] Other, please describe:

## What did you implement:

<!-- Describe the feature / bug fix you've implemented. -->

## What was the previous behavior:

<!-- Describe the previous behavior. -->

## How did you implement it:

<!-- Describe the technical implementation details. -->

## Other changes:

<!-- Describe any minor or "drive-by" changes made in this PR. -->

## Related issue(s):

<!-- If this PR closes any issue(s), please reference them here. -->
Loading
Loading