Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 4.42 KB

CONTRIBUTING.md

File metadata and controls

77 lines (52 loc) · 4.42 KB
Raw

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. Move the issue into the 'In progress' column on the project board, if you have the necessary access. If there's no issue associated with the work you'd like to do, your pull request is likely to be rejected until one is created and prioritized.
  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

Nodejs for front end package management and debugging.

Visual Studio Code for front end development.

Visual Studio 2017 Community for back end development.

pgAdmin 4 for database development.

Debugging

Front End

Front end 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 environment will be used for debugging.

Back End

To debug the back end locally, you'll need to create the environment variable QCVOC_DbConnectionString and set it to the connection string for the development database. Visit us on Slack to discuss this.

Open the project in the 'api' folder in Visual Studio. On the toolbar, click the drop-down button next to 'IIS Express' and select 'QCVOC.Api' from the resulting list. This will tell Visual Studio to debug using the dotnet console command. Click the debug (green arrow) button to start debugging. A console should appear, displaying the following:

Hosting environment: Development
Content root path: C:\Users\JP.WHATNET\source\QCVOC\api\QCVOC.Api
Now listening on: https://localhost:5001
Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.

Open a browser and navigate to http://localhost:5000/swagger to interact with the api via Swagger UI.

Expand the /security/login POST operation and execute it, providing your credentials. Copy the accessToken value from the result, then click on the green 'Authorize' button near the top of the screen to set your session authorization. Enter Bearer <accessToken> into the box and click Login. All future requests will be authenticated using this token.