A document with pragmatic standards and best-practices used by Nation3 developers.
If you are new to Nation3, see https://nation3.org/join for information on how to join the community 💚
Commits in a pull request should always be focused. For example, a commit could add a feature, fix a bug, or refactor code; but not a mixture. Please also avoid super commits which attempt to do too much, are overly large, or overly complex as this makes review difficult.
If the pull request is related to a GitHub issue, remember to include a reference to the GitHub issue in the description. Example: closes #123
Before requesting a review of your pull request, make sure that all the status checks are passing:
Also test that that your code changes work on both Sepolia and Mainnet.
We use ESLint as a linter, and Prettier to automatically format code so it adheres to our coding style. Default config files for both can be seen here and here. It is recommended to use Prettier inside your development environment to format your code with the right coding style on the fly.a
After creating a pull request, assign one of the Nation3 teams as reviewers.
When you have at least 1 approved review, merge the pull request.
We use Sepolia for our testnet deployments. You can get some testnet ETH from the QuickNode - Ethereum Sepolia Faucet.
$NATION tokens can be purchased from the Sepolia Balancer Pool at https://app.balancer.fi/#/sepolia/swap/ether/0x23Ca3002706b71a440860E3cf8ff64679A00C9d7
Once you hold $NATION tokens, head over to the staking page: https://app-sepolia.nation3.org/lock
$NATION to get 3 $veNATION (since your $veNATION balance decreases over time). |
|---|
See https://app.clarity.so/nation3-public/docs/9dcef8f6-ecd8-45f8-ab46-22d5f0fda30d