Skip to content

Commit

Permalink
Fix tests 2
Browse files Browse the repository at this point in the history
  • Loading branch information
dnlklmn committed Jan 10, 2024
1 parent df6bcd8 commit c1b263c
Show file tree
Hide file tree
Showing 4 changed files with 239 additions and 111 deletions.
46 changes: 20 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,39 @@
# CONTRIBUTING

Contributions are very welcome. When contributing code, please follow these
simple guidelines.
Contributions are very welcome. When contributing code, please follow these simple guidelines.

* Make sure you run `npm run check` for code formatting problems.
* Run our test suite `npm run test:*` to avoid regressions or bugs.
* Before adding any code dependencies, check with the maintainers if this is okay.
* Write properly formatted comments: they should be english sentences, eg:
- Make sure you run `npm run check` for code formatting problems.
- Run our test suite `npm run test:*` to avoid regressions or bugs.
- Before adding any code dependencies, check with the maintainers if this is okay.
- Write properly formatted comments: they should be english sentences, eg:

// Return the current UNIX time.

* Sign all your comments with your public key, using `git commit -S`.
* Follow the guidelines when proposing code changes (see below).
* Write properly formatted git commits (see below).
- Sign all your comments with your public key, using `git commit -S`.
- Follow the guidelines when proposing code changes (see below).
- Write properly formatted git commits (see below).

## Proposing changes

Proposing changes
-----------------
When proposing changes via a patch:

* Isolate changes in separate commits to make the review process easier.
* Don't make unrelated changes, unless it happens to be an obvious improvement to
code you are touching anyway ("boyscout rule").
* Rebase on `master` when needed.
* Keep your changesets small, specific and uncontroversial, so that they can be
merged more quickly.
* If the change is substantial or requires re-architecting certain parts of the
codebase, write a proposal in english first, and get consensus on that before
proposing the code changes.

Writing Git commit messages
---------------------------
A properly formed git commit subject line should always be able to complete the
following sentence:
- Isolate changes in separate commits to make the review process easier.
- Don't make unrelated changes, unless it happens to be an obvious improvement to code you are touching anyway ("boyscout rule").
- Rebase on `master` when needed.
- Keep your changesets small, specific and uncontroversial, so that they can be merged more quickly.
- If the change is substantial or requires re-architecting certain parts of the codebase, write a proposal in english first, and get consensus on that before proposing the code changes.

## Writing Git commit messages

A properly formed git commit subject line should always be able to complete the following sentence:

If applied, this commit will _____

For example, the following message is well formed:

Add support for .gif files

In addition, it should be capitalized and *must not* include a period.
In addition, it should be capitalized and _must not_ include a period.

When it comes to formatting, here's a model git commit message[1]:

Expand Down
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,19 @@ To propose changes open an [issue][is] or a [patch][pa] on [Radicle][ra].

### npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.
The page will reload if you make edits. You will also see any lint errors in the console.

### npm run build

Builds a static copy of your site to the `build/` folder.
Your app is ready to be deployed!
Builds a static copy of your site to the `build/` folder. Your app is ready to be deployed!

## Deployments

Latest public production deployment 👉 [app.radicle.xyz][ap]

If you want to connect to pre-heartwood nodes, you can run the app locally
using the `legacy` tag, available by running `git checkout legacy`.


If you want to connect to pre-heartwood nodes, you can run the app locally using the `legacy` tag, available by running `git checkout legacy`.

[ap]: https://app.radicle.xyz
[is]: https://app.radicle.xyz/nodes/seed.radicle.xyz/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5/issues
Expand Down
Loading

0 comments on commit c1b263c

Please sign in to comment.