Skip to content

Commit

Permalink
Swap links, remove weird wrap, migrate old docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Juuddi committed Jun 3, 2024
1 parent 5be5d6b commit 3d0dfb0
Show file tree
Hide file tree
Showing 16 changed files with 307 additions and 714 deletions.
95 changes: 0 additions & 95 deletions docs/basics/abi.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/basics/index.md

This file was deleted.

66 changes: 23 additions & 43 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,69 +2,49 @@

Pull requests are welcome, but please keep the following in mind:

- Backwards-compatibility-breaking changes will not be accepted;
they may be considered for the next major version
- Security is important; adding dependencies require fairly
convincing arguments as to why
- The library aims to be lean, so keep an eye on the
`dist/quais.min.js` file size before and after your
changes (the `build-clean` target includes these stats)
- Keep the PR simple, readable and confined to the relevant
files; see below for which files to change
- Add test cases for both expected and unexpected input
- Any new features need to be supported by me (future issues,
documentation, testing, migration), so anything that is
overly complicated or specific may not be accepted
- Everyone is working hard; **be kind and respectful**

It is always *highly recommended* that you open a [[link-discussion]]
**before** beginning a PR.
- Backwards-compatibility-breaking changes will not be accepted; they may be considered for the next major version
- Security is important; adding dependencies require fairly convincing arguments as to why
- The library aims to be lean, so keep an eye on the `dist/quais.min.js` file size before and after your changes (the `build-clean` target includes these stats)
- Keep the PR simple, readable and confined to the relevant files; see below for which files to change
- Add test cases for both expected and unexpected input
- Any new features need to be supported by me (future issues, documentation, testing, migration), so anything that is overly complicated or specific may not be accepted
- Everyone is working hard; **be kind and respectful**

It is always _highly recommended_ that you open a [quais Discussion](https://github.com/quais-io/quais.js/discussions) **before** beginning a PR.

## Documentation

The documentation is an area which can always benefit from extra
eyes, extra knowledge and extra examples.
The documentation is an area which can always benefit from extra eyes, extra knowledge and extra examples.

Contributing to the documentation is welcome, but when making
changes to documentation, please ensure that all changes are
made **only** to:
Contributing to the documentation is welcome, but when making changes to documentation, please ensure that all changes are made **only** to:

- Updating `/docs/*\*.md`
- Updating API jsdocs: `/*\* ... */` comment blocks within `/src/`
- Updating `/docs/*\*.md`
- Updating API jsdocs: `/*\* ... */` comment blocks within `/src/`

When adding a new sections, a [[link-discussion]] is
preferred.
When adding a new sections, a [quais Discussion](https://github.com/quais-io/quais.js/discussions) is preferred.

All changes should be in the JSdoc format.

### Fixing Bugs

In general the **only** files you should ever include in a PR are:

- TypeScript source: `/src/*\*.ts`

Do not include a `package.json` with the updated `tarballHash`
or `version`, and do not include any generated files in your PR.
- TypeScript source: `/src/*\*.ts`

A bug fix **must not** modify anything requiring a minor version
bump (see [[about-contrib-feature]]), such as changing a method
signature or altering the exports.
Do not include a `package.json` with the updated `tarballHash` or `version`, and do not include any generated files in your PR.

A bug fix **must not** modify anything requiring a minor version bump, such as changing a method signature or altering the exports.

### Adding Features

Contributing new features usually require a deeper understanding
of the internal interactions with quais and its components, and
generally requires a minor version bump.
Contributing new features usually require a deeper understanding of the internal interactions with quais and its components, and generally requires a minor version bump.

When making any of the following changes, you must first open a
[[link-discussion]] as the minor version will need to be bumped.
When making any of the following changes, you must first open a [quais Discussion](https://github.com/quais-io/quais.js/discussions) as the minor version will need to be bumped.

- any signature change (such as adding a parameter, changing a
parameter type, changing the return type)
- adding any new export; such as a class, function or constants
- adding any method to any class
- changing any `exports` property within the `package.json`
- any signature change (such as adding a parameter, changing a parameter type, changing the return type)
- adding any new export; such as a class, function or constants
- adding any method to any class
- changing any `exports` property within the `package.json`

Changes of this sort should not be made without serious consideration
and discussion.
8 changes: 0 additions & 8 deletions docs/cookbook/index.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/cookbook/react-native.md

This file was deleted.

Loading

0 comments on commit 3d0dfb0

Please sign in to comment.