Skip to content

Commit

Permalink
add contirbutors file (NEAR-DevHub#513)
Browse files Browse the repository at this point in the history
  • Loading branch information
DeleMike authored Nov 28, 2023
1 parent 8e687e1 commit 56c044c
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
13 changes: 13 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"files": ["README.md"],
"imageSize": 100,
"commit": false,
"contributorsPerLine": 5,
"projectName": "neardevhub-widgets",
"projectOwner": "near",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true,
"commitConvention": "none",
"badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#contributors)"
}
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,11 @@ npm run dev -a bob.near -c contract.bobs.near -n mainnet

By using these flags, you have the flexibility to customize the development environment according to your specific needs.


#### Developing across multiple environments

When referencing a component or any parameter that depends on the network, please use the placeholders defined in replacements.*.json. There are three such files that correspond to different environments:

`replacements.dev.json` - deploys the develop branch, to testnet @ test.beta.near.org
`replacements.dev.json` - deploys the develop branch, to testnet @ test.beta.near.org

`replacements.testnet.json` - deploys main branch, to testnet @ test.near.org

Expand Down Expand Up @@ -117,6 +116,15 @@ https://test.near.social/#/YOUR_ACCOUNT_ID/widget/gigs-board.pages.Feed?nearDevG

NOTE: If you have [DevHub contract](https://github.com/near/neardevhub-contract) deployed to the same account, you can skip the `nearDevGovGigsContractAccountId` argument, otherwise, feel free to use the contract deployed to `gigs.frol14.testnet` (on testnet) or `devgovgigs.near` (on mainnet).

### Contribution Recognition

We value all contributions, and to recognize your efforts, we follow the [All Contributors specification](https://allcontributors.org/docs/en/bot/usage). If you contribute, make sure to check the [types of contributions](https://allcontributors.org/docs/en/emoji-key) and add yourself as a contributor using the following command:

```bash
# Run this command in the root of your project after making a contribution
@all-contributors please add <username> as a contributor
```

#### Deploy for Production

There is GitHub Actions automation that deploys all the widgets to [`devgovgigs.near` account](https://near.social/#/mob.near/widget/MyPage?accountId=devgovgigs.near) on mainnet on every push to the main branch.
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,20 @@ We grant commit access to the Developer DAO team and any active developers who h

## How we work

We communicate primarily over GitHub. We recommend configuring your [notifications](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications) to ensure you get the latest updates.
We communicate primarily over GitHub. We recommend configuring your [notifications](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications) to ensure you get the latest updates.

[Learn more](https://github.com/near/devgigsboard-widgets/blob/main/docs/how-we-work.md) about how we work asynchronously.
[Learn more](https://github.com/near/devgigsboard-widgets/blob/main/docs/how-we-work.md) about how we work asynchronously.

## Contributors ✨

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

# Getting Help

Expand Down

0 comments on commit 56c044c

Please sign in to comment.