Skip to content

Commit

Permalink
first up
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr Martian committed Sep 8, 2024
0 parents commit 01ed758
Show file tree
Hide file tree
Showing 271 changed files with 27,096 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 🐛 Bug Report
description: Report an issue that should be fixed
labels: [bug]
body:

- type: markdown
attributes:
value: |
Thank you for submitting a bug report. It helps make Open S2 better.

If you need help or support using the s2-tools module, and are not reporting a bug, please join our [Discord](https://discord.opens2.com) server.

Please try to include as much information as possible.

- type: input
attributes:
label: What browser/engine are you using?
description: |
For example, Chrome, Firefox, Safari, Edge, NodeJS, Bun, Deno, etc.
validations:
required: true
- type: input
attributes:
label: What version of the browser/engine are you using?
description: |
For example, 89.0.4389.82
validations:
required: true
- type: textarea
attributes:
label: What steps can reproduce the bug?
description: Explain the bug and provide a code snippet that can reproduce it.
validations:
required: true
- type: textarea
attributes:
label: What is the expected behavior?
description: If possible, please provide text instead of a screenshot.
- type: textarea
attributes:
label: What do you see instead?
description: If possible, please provide text instead of a screenshot.
- type: textarea
attributes:
label: Additional information
description: Is there anything else you think we should know?
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/3-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 🚀 Feature Request
description: Suggest an idea, feature, or enhancement
labels: [enhancement]
body:

- type: markdown
attributes:
value: |
Thank you for submitting an idea. It helps make Open S2 better.

If you want to discuss the s2-tools module, or learn how others are using it, please join our [Discord](https://discord.opens2.com) server.
- type: textarea
attributes:
label: What is the problem this feature would solve?
validations:
required: true
- type: textarea
attributes:
label: What is the feature you are proposing to solve the problem?
validations:
required: true
- type: textarea
attributes:
label: What alternatives have you considered?
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/4-docs-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 📗 Documentation Issue
description: Tell us if there is missing or incorrect documentation
labels: [docs]
body:

- type: markdown
attributes:
value: |
Thank you for submitting a documentation request. It helps make Open S2 better.

The [documentation](https://opens2.com/docs/) is still under development. Please report as many issues or missing content requests as you can so we can incoperate that in the new documentation.
- type: dropdown
attributes:
label: What is the type of issue?
multiple: true
options:
- Documentation is missing
- Documentation is incorrect
- Documentation is confusing
- Example code is not working
- Something else
- type: textarea
attributes:
label: What is the issue?
validations:
required: true
- type: textarea
attributes:
label: Where did you find it?
description: If possible, please provide the URL(s) where you found this issue.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 💬 Ask a Question
url: https://discord.opens2.com
about: Join our Discord server for questions, support requests, or just to chat.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Feature Request

## Description
<!-- Provide a brief description of the requested feature -->

## Use Case
<!-- Describe the use case or scenario where this feature would be useful -->

## Proposed Solution
<!-- Describe your proposed solution or implementation for the requested feature -->

## Alternatives Considered
<!-- Describe any alternative solutions or approaches you considered, if applicable -->

## Additional Context
<!-- Add any other context, screenshots, or mockups about the feature request here -->

## Resources
<!-- If applicable, provide any relevant resources, links, or documentation that might support the feature request -->
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Pull Request

## Description
<!-- Provide a brief description of the changes made in this PR -->

## Motivation
<!-- Explain why these changes are necessary or beneficial -->

## Checklist

- [ ] Tests added/updated (if applicable)
- [ ] Documentation updated (if applicable)
- [ ] All new code is commented correctly ( if applicable)

## Additional Notes
<!-- Add any additional notes or context here -->
54 changes: 54 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: test-workflow

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
test:
name: Test
runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Bun
uses: oven-sh/setup-bun@v1
with:
bun-version: 1.1.8

- name: Install dependencies
run: bun install

- name: Run JavaScript/TypeScript tests
run: bun run test

- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true

- name: Install Clippy
run: rustup component add clippy

- name: Run Clippy
run: cargo clippy -- -D warnings
shell: bash

- name: Build Rust project
run: cargo build
shell: bash

- name: Run Rust tests
run: cargo test
shell: bash
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
node_modules
dist
featureCollections
out.json
switchTest.js
tsconfig.tsbuildinfo
.DS_Store
target/
zig-cache/
.zig-cache/
zig-out/
experiments/
zig/
49 changes: 49 additions & 0 deletions .helix/languages.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[[language]]
name = "rust"
auto-format = true
language-servers = ["rust-analyzer", "gpt"]
roots = ["Cargo.toml", "Cargo.lock"]
rulers = [100]

[language-server.rust-analyzer.config]
inlayHints.bindingModeHints.enable = false
inlayHints.closingBraceHints.minLines = 10
inlayHints.closureReturnTypeHints.enable = "with_block"
inlayHints.discriminantHints.enable = "fieldless"
inlayHints.lifetimeElisionHints.enable = "skip_trivial"
inlayHints.typeHints.hideClosureInitialization = false

[language-server.eslint]
command = "vscode-eslint-language-server"
args = ["--stdio"]

[language-server.eslint.config]
codeActionsOnSave = { mode = "all", "source.fixAll.eslint" = true }
format = { enable = true }
nodePath = ""
quiet = false
rulesCustomizations = []
run = "onType"
validate = "on"
experimental = {}
problems = { shortenToSingleLine = false }

[[language]]
name = "typescript"
language-servers = ["typescript-language-server", "eslint", "emmet-ls", "gpt"]
formatter = { command = "prettier", args = ["--parser", "typescript"] }
auto-format = true
rulers = [100]

[[language]]
name = "javascript"
language-servers = ["typescript-language-server", "eslint", "emmet-ls", "gpt"]
formatter = { command = "prettier", args = ["--parser", "typescript"] }
auto-format = true
rulers = [100]

[[language]]
name = "json"
language-servers = ["gpt"]
formatter = { command = "prettier", args = ["--parser", "json"] }
auto-format = true
12 changes: 12 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
test
featureCollections
backup
test
out.json
switchTest.js
test.js
newTriangle.gif
tsconfig.tsbuildinfo
.DS_Store
target/
zig/
5 changes: 5 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"plugins": [],
"printWidth": 100,
"singleQuote": true
}
69 changes: 69 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Contributing Guidelines

Contributions welcome!

**Before spending lots of time on something, ask for feedback on your idea first!**

Please search issues and pull requests before adding something new to avoid duplicating
efforts and conversations.

This project welcomes non-code contributions, too! The following types of contributions
are welcome:

- **Ideas**: participate in an issue thread or start your own to have your voice heard.
- **Writing**: contribute your expertise in an area by helping expand the included docs.
- **Copy editing**: fix typos, clarify language, and improve the quality of the docs.
- **Formatting**: help keep docs easy to read with consistent formatting.

## Code Style

This repository uses typescript with commonJS to maintain code style and consistency,
and to avoid style arguments.

## Project Governance

Individuals making significant and valuable contributions are given commit-access to the
project to contribute as they see fit. This project is more like an open wiki than a
standard guarded open source project.

### Rules

There are a few basic ground-rules for contributors:

1. **No `--force` pushes** or modifying the Git history in any way.
2. **Non-master branches** should be used for ongoing work.
3. **Significant modifications** like API changes should be subject to a **pull request**
to solicit feedback from other contributors.
4. **Pull requests** are _encouraged_ for all contributions to solicit feedback, but left to
the discretion of the contributor.

### Releases

Declaring formal releases remains the prerogative of the project maintainer.

### Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-
requests or changes by contributors where you believe you have something valuable to add
or change.

## Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

- (a) The contribution was created in whole or in part by me and I have the right to
submit it under the open source license indicated in the file; or

- (b) The contribution is based upon previous work that, to the best of my knowledge, is
covered under an appropriate open source license and I have the right under that license
to submit that work with modifications, whether created in whole or in part by me, under
the same open source license (unless I am permitted to submit under a different
license), as indicated in the file; or

- (c) The contribution was provided directly to me by some other person who certified
(a), (b) or (c) and I have not modified it.

- (d) I understand and agree that this project and the contribution are public and that a
record of the contribution (including all personal information I submit with it,
including my sign-off) is maintained indefinitely and may be redistributed consistent
with this project or the open source license(s) involved.
Loading

0 comments on commit 01ed758

Please sign in to comment.