Commit Graph

27 Commits

Author SHA1 Message Date
Dandelion Mané e459a82fae Test node 12 and node 10
This commit changes CI to test against node 12 and 10 instead of node 8.

I test against node 12 by default (it will be LTS soon, and it has a
number of nice improvements compared to 10). We test node10 on the
nightly and post-merge, that way we will still discover quickly if we
have a problem with node 10, but it won't slow down CI for merges.

I'm just dropping explicit support for node 8 entirely, since node 8 is
end-of-life soon (Dec 19).

Test plan: I've locally verified that `yarn test --full` passes for both
node 10 and node 12.
2019-07-09 13:09:17 +01:00
greenkeeper[bot] 4758cea2f8 Update dependencies to enable Greenkeeper 🌴 (#1201)
This commit enables Greenkeeper, along with an initial upgrade push for our dependencies.

I've reverted a number of upgrades, and also added them to the
greenkeeper ignore list. They mostly relate to babel/webpack stuff,
which I'm reluctant to dive into now (there have been major upgrades for
both babel and webpack) but we should address eventually. There are also
a few oddballs like whatwg-fetch and history.

Test plan: `yarn test --full` passes.
2019-07-05 20:10:02 +01:00
Seth Benton 13a90675a8 Fixes broken link README (#1122)
This commit fixes three broken links (two in the README, one in the prototype app) that were still pointing to https://discuss.sourcecred.io/.

Test plan:
Verify that there are no other bad links to the old Discourse location, by running `git grep "discuss.sourcecred.io"`.
2019-03-26 16:01:39 -07:00
Brian Litwin 072e2953a3
Readme: correct node link (#1078)
There's a bug in #1076 where  the Node link at
the bottom of the Readme catches the Node
link reference created earlier in the Readme and
links to 'https://nodejs.org/en/' instead of
'https://github.com/nodejs/node`.

Used @wpank's solution to add the Node link
using a reference text, so we could keep
the word "Node" linked, instead of using "Node.js",
which would suggest the organization instead of
the GitHub project.

Test Plan:
Testing that these links work in the live ReadMe on my
fork, instead of copy/pasting the changed bits into
a Markdown parser.
2019-01-30 07:28:25 -05:00
Brian Litwin c2e722ec9c
Readme: add link to git and node (#1076)
Added a link to Git and Node GitHub project pages.

Test Plan:
Ensure the links work.
2019-01-25 19:45:10 -05:00
Brian Litwin c9567654a0
README: Update new contributor label to "good first issue" (#1048)
In response to SourceCred/Mission#15, we switched the default new contributor label from "Contributions Welcome" to "good first issue". This updates the README to reflect that change.

Test Plan: make sure the link redirects to our Issues page filtered for "good first issue" labels.
2019-01-15 14:51:53 -05:00
Aseem Sood 83fa29688e minor tweak to starting instructions (#1046) 2019-01-10 16:52:08 -08:00
William Chargin 16ed92549a
readme: replace Travis badge with CircleCI badge (#912)
Summary:
See #902 for context.

Test Plan:
Push to GitHub; observe badge in rendered README.

wchargin-branch: readme-circleci-badge
2018-10-03 11:43:10 -07:00
William Chargin c7ba89b807
license: relicense under MIT + Apache-2 (#896)
Summary:
All contributors to SourceCred have agreed to this more permissive
licensing option:

  - @decentralion: [link to comment][decentralion]
  - @wchargin: [link to comment][wchargin]
  - @claireandcode: [link to comment][claireandcode]

[decentralion]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-420817902
[wchargin]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-420819732
[claireandcode]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-424914639

Archive link to thread: <https://archive.fo/BH2v5>

Resolves #812.

Test Plan:
Note that the GitHub tree explorer correctly links from the README to
the individual license files.

wchargin-branch: license-dual-mit-apache2
2018-09-26 19:28:41 -07:00
William Chargin 1a96894220
Document that GNU coreutils are required (#733)
Summary:
Resolves #698. See the linked issue and comment for more details.

Test Plan:
None.

wchargin-branch: document-gnu-coreutils
2018-08-30 08:58:32 -07:00
Dandelion Mané fef00877bf
README links to my introductory post on cred (#726)
Test plan: Check that links work.
2018-08-29 19:16:57 -07:00
Dandelion Mané c8a4940d3f
Link to https://discuss.sourcecred.io from README (#725)
Adds a badge, adds a link, slight rewrite of the contributing section.

Test plan: Check the links and badge works.
(The badge topic count is off, we'll see if it is at least directionally
correct over time.)
2018-08-29 17:51:54 -07:00
William Chargin 761b5a0875
Allow combining repositories at load time (#711)
Summary:
As a first pass toward support for analyzing whole organizations, we
allow loading multiple repositories with `sourcecred load`, combining
them into a single relational view and a single Git graph at load time.

Test Plan:
Run

```
node bin/sourcecred.js \
    load \
    sourcecred/example-git \
    sourcecred/example-github \
    sourcecred/sourcecred \
    --output sourcecred/examples \
    ;
```

and select `sourcecred/examples` from the web view. Filter “Repository”
nodes, and note that there are three.

Note that loading a single repository without `--output` still works,
that loading a single repository with `--output` still works (respecting
the alias name), and loading not exactly one repository without
`--output` yields an appropriate error message.

Note that `yarn sharness-full` still works.

wchargin-branch: load-combined
2018-08-29 14:52:26 -07:00
Dandelion Mané 332915ae8a
Update README.md (#700)
The README has been brought up to date, and many small improvements were made. 
See #700 for details.

Test plan: Thoroughly reviewed.
2018-08-23 22:04:43 -07:00
William Chargin 038d166972
Link to `CONTRIBUTING.md` from the README (#585)
Summary:
The information currently in the README is helpful but incomplete. We
now have a `CONTRIBUTING.md` guide, so we can simply link to that.

Test Plan:
None.

wchargin-branch: contributing-md-readme
2018-08-02 13:58:06 -07:00
William Chargin 3b5ad594bd
package.json: reorganize test commands (#571)
Summary:
Running `yarn test` (equiv. `npm test` or `npm run test`) now runs all
checks. It takes the place of the former `yarn travis`. This is more in
line with the expectation of a top-level `test` command: if it passes,
your code is good.

The `unit` command now runs Jest once, not in watch mode. It takes the
place of the former `ci-test`. To run tests in watch mode, run any of
the following:

  - `yarn unit --watch`, or
  - `npm run unit -- --watch`, or
  - `npm unit -- --watch`.

This behavior is more consistent with the standard behavior of commands
like `make test`. It is also empirically what @wchargin and
@decentralion want most of the time.

Test Plan:
Verify that each of the scripts `test`, `unit`, and `coverage` passes.
Verify that each of the aforementioned `--watch` invocations works.
Verify that `.travis.yml` has the correct `script:` command.

wchargin-branch: reorganize-test-command
2018-07-31 10:53:10 -07:00
Dandelion Mané 3266eb31fa
CLI takes repo strings as `owner/name` (#559)
Test plan:
```
$ yarn backend
$ node bin/sourcecred.js load sourcecred/sourcecred
```
2018-07-27 23:44:41 -07:00
William Chargin bdb9ae9c46
Demonstrate the GitHub token env var in the README (#556)
Summary:
Using the environment variable is the preferred way to interact with the
CLI, simply because it’s easier for users. We should demonstrate this
interface instead of the legacy flag-only version.

Paired with @decentralion.

wchargin-branch: readme-env-var
2018-07-27 20:59:54 -07:00
Claire L 854fd817c0
README: Adding contribution section (#518)
* README: Adding contribution section

* README: adding links to Prettier
2018-07-24 13:38:40 -07:00
Dandelion Mané 1cda37e91a
Update README (#482)
Rewrites the README to be a lot more concrete about what SourceCred is
doing, and to give more up-to-date information overall.

Test plan: The README includes a small code block with instructions for
turning on a local copy of the Cred Explorer. I ran this on my machine
(inside /tmp) and it worked locally.
2018-07-04 01:11:23 -07:00
Dandelion Mané d90cd3cf1b
Update README to reference our Discord (#363) 2018-06-08 12:30:44 -07:00
Dandelion Mané 8992f2a9f5
Update the README (#124)
- Give a more detailed and up-to-date vision for SourceCred
- Update the discuss link to point to Spectrum rather than Slack
- Wrap text
2018-04-09 08:49:54 +03:00
Dandelion Mané ef7160d7d4
Update README.md
Guide contributors to participate via issues.
2018-03-06 19:09:46 -08:00
William Chargin 2e5bea2f5e Add Travis badge to README (#59) 2018-03-02 15:06:46 -08:00
Dandelion Mané d41872b7b7
Update README.md (#31)
This reflects our current vision that SourceCred is aimed at valuing open-source contributions via a credit graph, not on directly creating cryptotokens
2018-02-26 17:06:06 -08:00
Dandelion Mané c9b2fcd21a
Simplify README, link to new docs 2018-02-05 00:09:14 -08:00
Dandelion Mané 7dd9155833
Initial draft of the README (#1)
* Initial commit of README

* Fix some typos, etc

* More tweaks.

* More iterations on markdown, etc

* Take Jay's suggestion
2018-02-04 12:04:40 -08:00