From 56c044ccf5407ce04ac267949aa8bd67292f649f Mon Sep 17 00:00:00 2001 From: Akindele Michael <49593618+DeleMike@users.noreply.github.com> Date: Tue, 28 Nov 2023 04:10:44 +0100 Subject: [PATCH] add contirbutors file (#513) --- .all-contributorsrc | 13 +++++++++++++ CONTRIBUTING.md | 12 ++++++++++-- README.md | 15 +++++++++++++-- 3 files changed, 36 insertions(+), 4 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 000000000..bf8ac057e --- /dev/null +++ b/.all-contributorsrc @@ -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)" +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5322294f..2e0554b80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 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. diff --git a/README.md b/README.md index 0215a50aa..9636995c3 100644 --- a/README.md +++ b/README.md @@ -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 ✨ + + + + + + + + + # Getting Help