Skip to content
Merged
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
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to FastForward
Thanks for taking the time to contribute to FastForward, it is volunteers like you who make this project possible.

## Contibuting bypasses

### Making the bypass
Initially, you may use the custom bypasses section on the extension's settings page to test out and formulate your bypass, but after that we reccomend using a code editor like [VSCode](https://code.visualstudio.com/download)/[Codium](https://vscodium.com/#install).

### Submitting a Pull Request

When submitting a pull please take care that:
- Your code follows [the code style](docs/CODE_STYLE.md#code-style)
- Commit messages should be descriptive
- If its a small change [squash all your commits](docs/Git_CLI.md#squashing-commits)
- Follow the pull request template

Consider joining the [Discord](https://discord.gg/RSAf7b5njt) so that we can discuss the PR in real time.
8 changes: 8 additions & 0 deletions docs/CODE_STYLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### Code style:
- [Standard JS](https://standardjs.com/rules.html) + [Prettier](https://prettier.io/)
- Unix EOL (LF)
- Newline at end of file

### How to set this up on VScode/Codium:
- Extension: [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=numso.prettier-standard-vscode)
- Newline at end of file: [stackoverflow.com/a/44704969](https://stackoverflow.com/a/44704969)
59 changes: 59 additions & 0 deletions docs/Git_CLI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Install git before using the any of the commands. https://git-scm.com/downloads

---
### Squashing commits
to make this:

>• Update readme.md
>
>• Update readme.md
>
>• Update readme.md
>
>• Update readme.md

Into this:

> • Fix link in README


Open the terminal and run the following commands.
NOTE: Remember to substitue all `<things>`
```
git clone https://github.com/<your username>/FastForward
```
```
cd FastForward
```
```
git reset --soft HEAD~<number of commits you want to squash>
```
```
git commit -m "<your message>"
```
NOTE: When git asks for your password use a [PAT](https://github.com/settings/tokens).
```
git push --force
```
---
### Fixing a messed up main branch
NOTE: If you have made any changes on your main brainch they **will be lost.**

Open the terminal and run the following commands.
NOTE: Remember to substitue all `<things>`
```
git clone https://github.com/<your username>/FastForward
```
```
cd FastForward
git remote add upstream https://github.com/FastForwardteam/FastForward
git fetch upstream
git checkout main
git reset --hard upstream/main

```

NOTE: When git asks for your password use a [PAT](https://github.com/settings/tokens).
```
git push origin main --force
```
5 changes: 0 additions & 5 deletions src/js/.jshintrc

This file was deleted.