openedev / contribute

Contribute to Edgeble AI Projects

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contribute Edgeble AI

This tutorial contains information about contribution steps and rules for Edgeble AI projects

Here are the steps to contribute meta-neu6b. Same steps applicable for other repos provided with changes in remote repo.

Open an issue

Issue can be raised by reseptive contributor or maintainer

Authenticate

add ssh-keys

User need to create new pair of ssh keys and upload them to the github setting

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh

install gh

sudo apt install gh

For more information check github cli interface.

https://cli.github.com/manual/

authenticate gh

user need to authenticate the user, select the github account, it will ask you to login to github using the local web browser. Once completed it will ask enter generated passphrase from the below command

$ gh auth login
? What account do you want to log into?  [Use arrows to move, type to filter]
> GitHub.com
  GitHub Enterprise Server
$ gh auth status
github.com
  ✓ Logged in to github.com as moonlinux (/home/amoon/.config/gh/hosts.yml)
  ✓ Git operations for github.com configured to use https protocol.
  ✓ Token: *******************

Send PR

push changes

Fork a copy of a repository that you manage. Forks let you make changes to a project without affecting the original repository. You can fetch updates from or submit changes to the original repository with pull requests.

Open the github repository in your browser and click the fork icon. Clone and push the changes to repository

Do local changes in the repository and verify the changes, so that they can be reviewed.

$ git clone git@github.com:username/meta-neu6b.git
$ git add 	# modified the files
$ git commit -s	# add a suitable commit message to describe the changes
(add Fixes #1 in above Signed-Off-by here #1 mean issues 1 that specific repository)

Verify the build and feature work correctly as per the requirement. Add the new remote github username to the existing local branch

$ git remote add username git@github.com:username/meta-neu6b.git

Verify the github username is added to remote repository

$ git remote -v
username     git@github.com:username/meta-neu6b.git (fetch)
username     git@github.com:username/meta-neu6b.git (push)
origin  git@github.com:edgeble/meta-neu6b.git (fetch)
origin  git@github.com:edgeble/meta-neu6b.git (push)

Push the changes to github repository. depending on the branch you need to update below. use -f if we want to push multiple times based on previous pr review.

$ git push -f username kirkstone:kirkstone

Send a pull request

This pull request will asked send the changes to original repository via github

$ gh pr create --title "Suitable title" --body "describes the commit changes"

About

Contribute to Edgeble AI Projects