Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/readmefile #5

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Feat/readmefile #5

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c049c85
Feat: Adds contributing guides to readme.md file
amarealcoder Nov 17, 2022
805dcf8
Feat: Adds contributing guides to readme.md file
amarealcoder Nov 17, 2022
b963b44
Feat: Correction in the readme file
Nov 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,30 @@
# salesaccount.web
# salesaccount.web

## Contributing

Contributions are always welcome!

Please adhere to this project's `code of conduct`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently don't have a code of conduct so I don't think this line is neccessary


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.