Skip to content

Commit

Permalink
convert files from CRLF endings to LF endings (#49)
Browse files Browse the repository at this point in the history
% find . -type f -exec file {} \; | grep CRLF | cut -d ':' -f 1 | xargs dos2unix
dos2unix: converting file ./.gitignore to Unix format...
dos2unix: converting file ./sidebars.js to Unix format...
dos2unix: converting file ./tsconfig.json to Unix format...
dos2unix: converting file ./docusaurus.config.js to Unix format...
dos2unix: converting file ./babel.config.js to Unix format...
dos2unix: converting file ./src/components/Download.tsx to Unix format...
dos2unix: converting file ./src/components/LinkIcon.tsx to Unix format...
dos2unix: converting file ./src/components/labelselector.module.css to Unix format...
dos2unix: converting file ./src/components/download.module.css to Unix format...
dos2unix: converting file ./src/components/LabelSelector.tsx to Unix format...
dos2unix: converting file ./src/css/custom.css to Unix format...
dos2unix: converting file ./src/config/boards.tsx to Unix format...
dos2unix: converting file ./src/hooks/useGitHubInfo.ts to Unix format...
dos2unix: converting file ./development/documentation-preview.mdx to Unix format...
dos2unix: converting file ./development/contribution-guide.mdx to Unix format...
dos2unix: converting file ./development/firmware-development.mdx to Unix format...
dos2unix: converting file ./development/templates.mdx to Unix format...
dos2unix: converting file ./development/documentation-update-downloads.mdx to Unix format...
dos2unix: converting file ./.github/workflows/deploy.yml to Unix format...
dos2unix: converting file ./.github/workflows/test-deploy.yml to Unix format...
dos2unix: converting file ./docs/rgb-leds.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/bootsel-button.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/joystick-selection-slider.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/input-reverse.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/analog.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/focus-mode.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/socd-selection-slider.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/wii-extensions.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/turbo.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/player-number.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/i2c-analog-ads1219.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/snes-input.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/on-board-led.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/dual-direction-input.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/input-history.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/keyboard-host.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/tilt-input.mdx to Unix format...
dos2unix: converting file ./docs/add-ons/buzzer-speaker.mdx to Unix format...
dos2unix: converting file ./docs/snippets/_input-table.mdx to Unix format...
dos2unix: converting file ./docs/snippets/_hotkey-note.mdx to Unix format...
dos2unix: converting file ./docs/snippets/_add-usb-host-port.mdx to Unix format...
dos2unix: converting file ./docs/snippets/_pin-options-USB-Host.mdx to Unix format...
dos2unix: converting file ./docs/snippets/_i2c-block-table.mdx to Unix format...
dos2unix: converting file ./docs/usage.mdx to Unix format...
dos2unix: converting file ./docs/installation.mdx to Unix format...
dos2unix: converting file ./docs/faq/faq-troubleshooting.mdx to Unix format...
dos2unix: converting file ./docs/faq/faq-general.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/02-pin-mapping.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/11-danger-zone.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/05-led-configuration.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/10-data-backup-restoration.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/06-custom-led-theme.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/00-home.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/08-add-ons-configuration.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/01-settings.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/09-macros.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/menu-pages/07-display-configuration.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/web-configurator.mdx to Unix format...
dos2unix: converting file ./docs/web-configurator/community-splash-screens.mdx to Unix format...
dos2unix: converting file ./docs/hotkeys.mdx to Unix format...
dos2unix: converting file ./docs/getting-help-support.mdx to Unix format...
dos2unix: converting file ./docs/controller-build/wiring.mdx to Unix format...
dos2unix: converting file ./docs/introduction.mdx to Unix format...
  • Loading branch information
bsstephan committed Apr 21, 2024
1 parent 56211ad commit 3cd5a8d
Show file tree
Hide file tree
Showing 66 changed files with 5,247 additions and 5,274 deletions.
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
* text=auto
80 changes: 40 additions & 40 deletions .github/workflows/deploy.yml
@@ -1,40 +1,40 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main

permissions:
id-token: write
pages: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

# Build steps
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Install dependencies
run: npm install --frozen-lockfile
working-directory: ./
- name: Build
run: npm run build
working-directory: ./

- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
name: Deploy to GitHub Pages

on:
push:
branches:
- main

permissions:
id-token: write
pages: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

# Build steps
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Install dependencies
run: npm install --frozen-lockfile
working-directory: ./
- name: Build
run: npm run build
working-directory: ./

- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
52 changes: 26 additions & 26 deletions .github/workflows/test-deploy.yml
@@ -1,26 +1,26 @@
name: Test Docs Deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test docs deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm install --frozen-lockfile
working-directory: ./
- name: Test build website
run: npm run build
working-directory: ./
name: Test Docs Deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test docs deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm install --frozen-lockfile
working-directory: ./
- name: Test build website
run: npm run build
working-directory: ./
36 changes: 18 additions & 18 deletions .gitignore
@@ -1,19 +1,19 @@
.DS_Store
.vscode/*
!.vscode/extensions.json
.idea
*.iml
*.code-workspace
.changelog
.history

node_modules
.yarn

.eslintcache

yarn-error.log
build

.docusaurus
.DS_Store
.vscode/*
!.vscode/extensions.json
.idea
*.iml
*.code-workspace
.changelog
.history

node_modules
.yarn

.eslintcache

yarn-error.log
build

.docusaurus
.cache-loader
6 changes: 3 additions & 3 deletions babel.config.js
@@ -1,3 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
110 changes: 55 additions & 55 deletions development/contribution-guide.mdx
@@ -1,55 +1,55 @@
---
title: How to Contribute
# tags:
# -
pagination_next: null
pagination_prev: null
description: "How to contribute to the GP2040-CE Project"
---

# How to Contribute

Thank you for taking the time to read this and contributing to the project!

Third-party contributions help us grow and improve GP2040-CE. We want to make the pull request and contribution process useful and easy for both contributors and maintainers.

To this end we’ve put together some guidelines for contributors to help your pull request be accepted without major changes.

## Project Overview

GP2040-CE is largely written in C/C++, with a significant portion of the web configurator written in JavaScript within a React framework.

## How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in GP2040-CE? Here’s a quick rundown!

1. Sign up for a GitHub account.
2. Find an issue you are interested in addressing, or a feature you would like to add.
3. Fork the repository associated with the issue to your GitHub account. This means that you will have a copy of the repository under `your-GitHub-username/GP2040-CE`.
4. Clone the repository to your local machine using `git clone https://github.com/OpenStickCommunity/GP2040-CE`
5. If you’re working on a new feature consider opening an issue to talk with us about the work you’re about to undertake.
6. Create a new branch for your fix using `git checkout -b branch-name-here`.
7. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
8. Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the “snapshot” git uses to manage the state of the project, also known as the index.
9. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
10. Push the changes to your repository on GitHub using `git push origin branch-name-here`.
11. Submit a pull request to [OpenStickCommunity/GP2040-CE](https://github.com/OpenStickCommunity/GP2040-CE).
12. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so “Added more log outputting to resolve #4352”.
13. In the description of the pull request explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It’s OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
14. Wait for the pull request to be reviewed by a maintainer.
15. Make changes to the pull request if the reviewing maintainer recommends them.
16. Celebrate your success after your pull request is merged!

## Coding Conventions

## General Guidelines

- **Before you contribute**: Please make sure your fork is up to date with the upstream `GP2040-CE` repo. This will help minimize CI failures that may not occur for you when compiling locally.
- Separate PRs into logical units. For example, do not submit one PR covering two separate features, instead submit a separate PR for each feature.
- Check for unnecessary whitespace with `git diff --check` before committing.
- Make sure your code change actually compiles.
- Make sure commit messages are understandable on their own. You should put a short description (no more than 70 characters) on the first line, the second line should be empty, and on the 3rd and later lines you should describe your commit in detail, if required.

## Documentation

Documentation is one of the easiest ways to get started contributing to GP2040-CE. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren’t sure where or how to jump in please [reach out for help](/getting-help-support)!
---
title: How to Contribute
# tags:
# -
pagination_next: null
pagination_prev: null
description: "How to contribute to the GP2040-CE Project"
---

# How to Contribute

Thank you for taking the time to read this and contributing to the project!

Third-party contributions help us grow and improve GP2040-CE. We want to make the pull request and contribution process useful and easy for both contributors and maintainers.

To this end we’ve put together some guidelines for contributors to help your pull request be accepted without major changes.

## Project Overview

GP2040-CE is largely written in C/C++, with a significant portion of the web configurator written in JavaScript within a React framework.

## How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in GP2040-CE? Here’s a quick rundown!

1. Sign up for a GitHub account.
2. Find an issue you are interested in addressing, or a feature you would like to add.
3. Fork the repository associated with the issue to your GitHub account. This means that you will have a copy of the repository under `your-GitHub-username/GP2040-CE`.
4. Clone the repository to your local machine using `git clone https://github.com/OpenStickCommunity/GP2040-CE`
5. If you’re working on a new feature consider opening an issue to talk with us about the work you’re about to undertake.
6. Create a new branch for your fix using `git checkout -b branch-name-here`.
7. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
8. Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the “snapshot” git uses to manage the state of the project, also known as the index.
9. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
10. Push the changes to your repository on GitHub using `git push origin branch-name-here`.
11. Submit a pull request to [OpenStickCommunity/GP2040-CE](https://github.com/OpenStickCommunity/GP2040-CE).
12. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so “Added more log outputting to resolve #4352”.
13. In the description of the pull request explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It’s OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
14. Wait for the pull request to be reviewed by a maintainer.
15. Make changes to the pull request if the reviewing maintainer recommends them.
16. Celebrate your success after your pull request is merged!

## Coding Conventions

## General Guidelines

- **Before you contribute**: Please make sure your fork is up to date with the upstream `GP2040-CE` repo. This will help minimize CI failures that may not occur for you when compiling locally.
- Separate PRs into logical units. For example, do not submit one PR covering two separate features, instead submit a separate PR for each feature.
- Check for unnecessary whitespace with `git diff --check` before committing.
- Make sure your code change actually compiles.
- Make sure commit messages are understandable on their own. You should put a short description (no more than 70 characters) on the first line, the second line should be empty, and on the 3rd and later lines you should describe your commit in detail, if required.

## Documentation

Documentation is one of the easiest ways to get started contributing to GP2040-CE. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren’t sure where or how to jump in please [reach out for help](/getting-help-support)!

0 comments on commit 3cd5a8d

Please sign in to comment.