Skip to content

Commit

Permalink
Minor edits to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
HasanMothaffar committed Jun 21, 2022
1 parent cc6c0a7 commit 71094fd
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ yarn start

6. A browser page should automatically open with the project running in it.

## Tech stack

- Three.js
- TypeScript
- Husky and ESLint
- Webpack

## Development Server

It's a webserver provided by [webpack](http://webpack.js.org/) that serves the project while being built in realtime and stored in memory.
Expand Down Expand Up @@ -69,4 +76,4 @@ The build can be then accessed at `/dist` and could be served as static page con

## Credits

Icons are from: https://www.svgrepo.com/
Icons are from: https://www.svgrepo.com/
16 changes: 8 additions & 8 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Styleguide
# Contributing to Satellite Simulator VI

To ensure the best code quality possible, please follow the guidelines below.
To ensure the best code quality possible when initiating a Pull Request, please follow the guidelines below.

## Contributing Code
## Contribution workflow

When you want to add a new feature, bug fix, or whatever that you think will be a good addition to the project, it's highly recommended that you stick to the workflow below:
When you want to add a new feature, bug fix, or whatever that you think will be a good addition to the project, please stick to this workflow:

1. Create a new local branch from `origin/main`
2. Select a proper name for your branch that reflects your contribution.
3. Add your code.
4. Push your code to a branch on the remote (origin) with the same name as your local branch.
5. Go to the `pull requests` tab in Codeberg, and create a new pull request.
5. Go to the `pull requests` tab and create a new pull request.
6. If there's an issue that's related to your feature, please reference it in the pull request's description.

To reference an issue in a pull request, just write the issue's number preceded by a `#` in the pull request's description.
Expand Down Expand Up @@ -41,9 +41,9 @@ Try to squash them into a `Introduce feature XYZ`.

More on this here: https://spin.atomicobject.com/2017/04/23/maintain-clean-git-history/

## Linting and Prettifying
## Linting

Before commiting code to any branch, husky will run `prettier` and `eslint` against the staged files. If there are any errors, you have to fix them before being able to commit them.
Before commiting code to any branch, husky will run `eslint` against the staged files. If there are any errors, you have to fix them before being able to commit them.

You can specify other scripts to run before the commit phase using the `lint-staged` key in the `package.json` file.

Expand Down Expand Up @@ -77,4 +77,4 @@ const color_picker = {};

It's highly, highly recommended that you use proper types for everything that you write. They not only prevent possible bugs, but also add intellisense support.

If you think that the type that you want to write can be used in many different places, please put it in the `src/models` folder so others can use it.
Using `any` is frowned-upon, unless you have a valid reason to do so.

0 comments on commit 71094fd

Please sign in to comment.