-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #153 from qccoders/develop
Prod deploy MVP.01
- Loading branch information
Showing
2 changed files
with
71 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, | ||
email, or any other method with the owners of this repository before making a change. | ||
|
||
We don't maintain a Contributor License Agreement (CLA) but we do require that anyone that wishes to contribute agrees to the following: | ||
|
||
* You have the right to assign the copyright of your contribution. | ||
* By making your contribution, you are assigning copyright of your contribution to the maintainers of this repository. | ||
|
||
In layman's terms, make sure that anything you contribute is yours to give, and understand that when you give it to us we own the legal rights to it. | ||
|
||
This project is maintained for free and for a non profit organization, and we require these things to insulate ourselves and the recipient from legal issues. | ||
|
||
## Contribution Workflow | ||
|
||
1. Assign yourself to the issue that you'll be working on. If there's no issue, your pull request is likely | ||
to be rejected until one is created and prioritized. Move the issue into the 'In progress' column on the project | ||
board, if you have the necessary access. | ||
2. Clone the repository and `git checkout develop` to ensure you are on the development branch. | ||
3. Create a new branch for your change with `git checkout -b <your-branch-name>` be descriptive, but terse. | ||
4. Make your changes. When finished, push your branch with `git push origin --set-upstream <your-branch-name>`. | ||
5. Create a pull request to merge `<your-branch-name>` into `develop`. Pull requests to `master` are only accepted from | ||
maintainers. | ||
6. A maintainer will review your pull request and may make comments, ask questions, or request changes. When all | ||
feedback has been addressed the pull request will be approved, and after all checks have passed it will be merged by | ||
a maintainer, or you may merge it yourself if you have the necessary access. | ||
7. Delete your branch, unless you plan to submit additional pull request from it. | ||
|
||
Note that we require that all branches are up to date with target branch prior to merging. If you see a message about this | ||
on your pull request, use `git fetch` to retrieve the latest changes, `git rebase origin/develop` to rebase your | ||
branch onto `develop`, and finally `git push origin <your-branch-name> -f` to push your updated branch to the repository. | ||
|
||
## Environment Setup | ||
|
||
You're free to use whichever development tools you prefer. If you don't yet have a preference, we recommend the following: | ||
|
||
[Git](https://git-scm.com/downloads) | ||
|
||
[Nodejs](https://nodejs.org/en/) for front end package management and debugging. | ||
|
||
[Visual Studio Code](https://code.visualstudio.com/) for front end development. | ||
|
||
[Visual Studio 2017 Community](https://visualstudio.microsoft.com/downloads/) for back end development. | ||
|
||
[pgAdmin 4](https://www.pgadmin.org/) for database development. | ||
|
||
## Debugging | ||
### Front End | ||
|
||
Front debugging is most easily expressed as a series of console commands, executed from the root folder of the repository: | ||
|
||
``` | ||
cd web | ||
npm install | ||
npm start | ||
``` | ||
|
||
On Windows, a browser should open and should navigate to the application. By default the development back end will be used for debugging. | ||
|
||
### Back End | ||
|
||
TBD |