diff --git a/README.md b/README.md index 61b1eb6d..c78b5ee0 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# salesaccount.web \ No newline at end of file +# salesaccount.web + +## Contributing + +Contributions are always welcome! + + +Before you contribute, please read through this document. + +1. Clone this repo using: `git clone https://github.com/workshopapps/salesaccount.web.git`. + +2. Change directory into the frontend directory using: `cd frontend`. + +3. Install dependencies using: `npm install`. + +4. Checkout to dev branch using: `git checkout dev`. + +5. Create your feature branch by running `git checkout -b BRANCH_NAME`. Please do not work from the `main branch`. + + +Work, add files and make commits. + +6. After working on your feature use `git add .` to add your changes. + +7. Add a commit message using: `git commit -m YOUR_MESSAGE`. Make the message descriptive. + +8. Push your work using: `git push origin BRANCH_NAME` + +9. Open the project GitHub page. You'll see an alert asking you to compare and make a PR. Change the base branch to dev and make a PR. \ No newline at end of file