search

finos / a11y-theme-builder

DesignOps toolchain theme builder for accessibility inclusion using Atomic Design.
Apache License 2.0
33 stars 68 forks source link

documentation enhancement in DEV_GUIDE.md #850

Closed omesh-omg closed 1 week ago

omesh-omg commented 4 weeks ago

No mention of using dev branch as upstream not the main

Sweetdevil144 commented 3 weeks ago

We can add a new section to the DEV_GUIDE.md after the 'Fetch Latest Code' section. This new section will provide instructions on how to set the dev branch as the upstream branch for development. Also, we can add abit of dev-intro related to knowledge of fetching and upstreams to contributors.

Maybe adding the below section helps users.

### Set Upstream Branch

After cloning the repository, it's recommended to set the `dev` branch as the upstream branch for development. 
This is a common practice in many development workflows where all the development happens in the `dev` branch and then it's merged into the `main` branch when it's ready for production. 

Here's how you can do it:

git checkout dev
git branch --set-upstream-to=origin/dev
omesh-omg commented 3 weeks ago

image I think this is what you are asking for ? Is this fine

omesh-omg commented 3 weeks ago

Please mention further suggestions if any

Sweetdevil144 commented 3 weeks ago

LGTM !!

omesh-omg commented 1 week ago

https://github.com/finos/a11y-theme-builder/pull/848 the PR is merged we are closing this. @aaronreed708