README of contributors

[boxizen]

01 Discover Tasks

There are issues labeled help wanted in the repository, which have been screened by the team and deemed high-priority bugs that can be reproduced or features where contributors are actively sought.

Readers can click on this label to filter out all the help wanted issues. High-priority issues mainly revolve around three dimensions: user experience, project infrastructure, and feature support. We welcome everyone to take on these development tasks.

02 PR

02-1 Fork

02-2 Sync Code

It is recommended to sync the latest code from the upstream repository before each local code submission, otherwise there may be a lot of conflicts that need to be dealt with. GitHub provides a feature on the webpage to perform upstream syncing operations.

However, it's recommended to link the remote upstream repository by adding it after cloning the repository to the local machine, as follows:

$ git remote add upstream https://github.com/onepointAI/onepoint.git
$ git remote -v
> origin    [email protected]:${USER}/${PROJECT}.git (fetch)
> origin    [email protected]:${USER}/${PROJECT}.git (push)
> upstream    https://github.com/onepointAI/onepoint.git (fetch)
> upstream    https://github.com/onepointAI/onepoint.git (push)

In this way, you can directly sync the changes from the upstream repository to your local machine by using the following method:

git fetch upstream
git rebase upstream/main

02-3 Create Branch

Checkout a new feat/fix branch from main after syncing the code from remote repository:

git checkout main
git checkout -b feat/xxx

02-4 Commit

The translation of this sentence is: "After local development is completed, you need to execute yarn format and yarn format-check to ensure that the results pass (even if you don't execute husky, it will be executed by default before commit lol).

Also, please follow the Angular Commit Guidelines for commit messages, as follows：

feat：new feature
fix：fix bugs
docs：changes of document
style：style fix or add
refactor：refactor the code
test：add tests
chore：changes of cicd

02-5 Fianlly

Create a pull request in the project you forked on your homepage.

03 Incentives for developers

After submitting a PR, the team will follow up on the merge request. Once all reviews and CI are passed, you will see your beautiful photo on the project homepage 🎉

Additionally, the project issued OnePoint NFT, and the team will regularly (initially once a week) calculate the developer's contribution and tailor an AVATAR NFT for them, which will be given away for free. The NFT's appearance is shown below and will be customized based on the photo you provide: