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.

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

Add initial readme instructions #11

Merged
merged 6 commits into from
Jan 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
71 changes: 71 additions & 0 deletions CONTRIBUTION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing Guide
### Choosing Stories/tickets.

When deciding on an issue to work on, look for the `Help Wanted` or `Good First Issue` tags.

### How to create a feature branch

```
Felistas marked this conversation as resolved.
Show resolved Hide resolved
git checkout develop
```
```
git pull upstream develop
```

Ensure you have setup AgileVentures/WebsiteOne-FE's upstream `develop`. Otherwise you will not have the latest `develop ` changes.

To confirm this, run ```git remote -v```.

You should see a simillar output.

```
origin  https://github.com/yourgithubusername/WebsiteOne-FE.git (fetch)
origin  https://github.com/yourgithubusername/WebsiteOne-FE.git (push)
upstream    https://github.com/AgileVentures/WebsiteOne-FE (fetch)
upstream    https://github.com/AgileVentures/WebsiteOne-FE (push)
```

If not, you need to set the remote develop in order to get the latest copy once changes are merged.

Inorder to achieve that, run:

```
git remote add upstream https://github.com/AgileVentures/WebsiteOne-FE
```

```
git pull upstream develop
```

This depends on the name of your origin (Counter check before running the above command).

You will now have the latest copy of develop in your local.


Once this is done, you can proceed with naming your branch following the below convention.

### Branch Naming Conventions

```
git checkout -b 17-add-agileventures-logo
```


Where `17` is the ticket number and `add-agileventures-logo ` is a short description of the purpose of your branch.

### Commit Messages

Ensure your commit message clearly communicate the work you have done.

For example,
```
git commit -m "Implement user login"
```

### Pull Requests

For your Pull Requests, ensure you have a proper title describing your task.
Make sure to add a link to the ticket you've worked on and add any screenshots if necessary.


Your pull request needs to be reviewed by at least two people in the team for it to be merged in `delop` branch.
36 changes: 36 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
[![Coverage Status](https://coveralls.io/repos/github/AgileVentures/WebsiteOne-FE/badge.svg?branch=develop)](https://coveralls.io/github/AgileVentures/WebsiteOne-FE?branch=develop)

# AgileVentures Website React Front End


Project Installation
--------------------

```
$ Fork this project by clicking on the Fork button on the top-right section of this page.
$ Navigate to the forked project in your repo.
$ git clone https://github.com/yourgithubusername/WebsiteOne-FE.git
$ cd WebsiteOne-FE
$ Run yarn install. Ensure you have yarn installed globally.
```

Run the application
-------------------

```
$ yarn start
```

Run tests
---------

```
$ yarn test
```
# Rebuild the semantic UI asserts
## This command needs to be run with npm - yarn does not support interactive prompt installs
`# npm install --save-dev semantic-ui`
Expand All @@ -17,3 +44,12 @@ use the default values
and copy the folder to our src folder

`cp -R dist/* ../src/assets/`
=======

### [Code of Conduct](./CODE_OF_CONDUCT).
### [Contribution Guide](./CONTRIBUTION_GUIDE).


### License

[MIT licensed](./LICENSE).