Contributing to ACI Rental

We'd love for you to contribute to our source code and to make ACI Rental even better than it is today!

Here are the guidelines we'd like you to follow:

Issues and Bugs
Submission Guidelines
Contributing as an 'insider'
Contributing as an 'outsider'
Getting started
Coding Format
More information

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to this repository. Even better you can submit a Pull Request with a fix.

Submission Guidelines

Submitting an Issue

If your issue appears to be a bug and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

Overview of the Issue - if an error is being thrown a non-minified stack trace helps
Reproduce the Error - provide details, if possible, on how to reproduce the error
Related Issues - has a similar issue been reported before?
Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Contributing as an 'insider'

Please follow the steps below when you are a member of this repository and would like to contribute.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Make a branch with the following conventions:
- Issue for the bug or feature exists
- Starts with the number of the issue
- Branch is based on dev
- Ex: 45-add-rental-page or 46-fix-login-null-exception
Create your patch and run/create the appropriate tests
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: “change” not “changed” nor “changes”.
```
git commit -a
```
Note: the optional commit -a command line option will automatically “add” and “rm” edited files.
Push your branch to GitHub:
```
git push origin 45-add-rental-page
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. 45-add-rental-page).
Push the changes to your branch (this will update your Pull Request). If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

Contributing as an 'outsider'

Please follow the steps below when you are not a member of this repository, but would still like to contribute to this project.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Fork either the front-end, backend or both.

Clone your copy.

git clone https://github.com/YOUR_USERNAME/[front-end/backend].git
cd [front-end/backend]/

After cloning, set a new remote upstream (this helps to keep your fork up to date)
```
git remote add upstream https://github.com/ACI-Rental/[front-end/backend].git
```
Make your changes in a new git branch:
```
git checkout -b my-fix-branch dev
```
Create your patch and run appropriate tests.
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: "change" not "changed" nor "changes".
```
git commit -a
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. my-fix-branch).
Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
Check out the dev branch:
```
git checkout dev -f
```
Delete the local branch:
```
git branch -D my-fix-branch
```
Update your dev with the latest upstream version:
```
git pull --ff upstream dev
```

Getting started

Front-end

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information)

mkdir ACI && cd ACI
git clone https://github.com/ACI-Rental/front-end.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

mkdir ACI && cd ACI
git clone https://github.com/<YOUR_USERNAME>/front-end.git

After this, install all the packages:

npm install

After this the application can be started using:

npm run

Backend

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information):

cd ACI
git clone https://github.com/ACI-Rental/backend.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

cd ACI
git clone https://github.com/<YOUR_USERNAME>/backend.git

The backend uses your environment variables to receive the database connection string. Make sure the environment variable is on 'system' level:

The backend tries to replace the string 'DATABASE_NAME' in the connection string to it's service schema. Ex: Server=<SERVER_URL>;Database=DATABASE_NAME;User ID=<USERNAME>;Password=<PASSWORD>;Trusted_Connection=False;Encrypt=True; Will become Server=<SERVER_URL>;Database=ProductService;User ID=<USERNAME>;Password=<PASSWORD>;Trusted_Connection=False;Encrypt=True;

After this the project can be started using Visual Studio or the dotnet command line. To run multiple services:

Right click solution -> Startup project -> Mutliple startup projects -> set the desired microservices to 'Start'

Coding Format

Please read our code conventions to ensure code quality and readability.

More information

For more information about contribution, design-choices, deployment and code quality, please refer to the folder docs in this repository.

Contributing to ACI Rental

We'd love for you to contribute to our source code and to make ACI Rental even better than it is today!

Here are the guidelines we'd like you to follow:

Issues and Bugs
Submission Guidelines
Contributing as an 'insider'
Contributing as an 'outsider'
Getting started
Coding Format
More information

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to this repository. Even better you can submit a Pull Request with a fix.

Submission Guidelines

Submitting an Issue

If your issue appears to be a bug and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

Overview of the Issue - if an error is being thrown a non-minified stack trace helps
Reproduce the Error - provide details, if possible, on how to reproduce the error
Related Issues - has a similar issue been reported before?
Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Contributing as an 'insider'

Please follow the steps below when you are a member of this repository and would like to contribute.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Make a branch with the following conventions:
- Issue for the bug or feature exists
- Starts with the number of the issue
- Branch is based on dev
- Ex: 45-add-rental-page or 46-fix-login-null-exception
Create your patch and run/create the appropriate tests
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: “change” not “changed” nor “changes”.
```
git commit -a
```
Note: the optional commit -a command line option will automatically “add” and “rm” edited files.
Push your branch to GitHub:
```
git push origin 45-add-rental-page
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. 45-add-rental-page).
Push the changes to your branch (this will update your Pull Request). If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

Contributing as an 'outsider'

Please follow the steps below when you are not a member of this repository, but would still like to contribute to this project.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Fork either the front-end, backend or both.

Clone your copy.

git clone https://github.com/YOUR_USERNAME/[front-end/backend].git
cd [front-end/backend]/

After cloning, set a new remote upstream (this helps to keep your fork up to date)
```
git remote add upstream https://github.com/ACI-Rental/[front-end/backend].git
```
Make your changes in a new git branch:
```
git checkout -b my-fix-branch dev
```
Create your patch and run appropriate tests.
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: "change" not "changed" nor "changes".
```
git commit -a
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. my-fix-branch).
Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
Check out the dev branch:
```
git checkout dev -f
```
Delete the local branch:
```
git branch -D my-fix-branch
```
Update your dev with the latest upstream version:
```
git pull --ff upstream dev
```

Getting started

Front-end

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information)

mkdir ACI && cd ACI
git clone https://github.com/ACI-Rental/front-end.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

mkdir ACI && cd ACI
git clone https://github.com/<YOUR_USERNAME>/front-end.git

After this, install all the packages:

npm install

After this the application can be started using:

npm run

Backend

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information):

cd ACI
git clone https://github.com/ACI-Rental/backend.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

cd ACI
git clone https://github.com/<YOUR_USERNAME>/backend.git

After this the project can be started using Visual Studio or the dotnet command line. To run multiple services:

Right click solution -> Startup project -> Mutliple startup projects -> set the desired microservices to 'Start'

Coding Format

Please read our code conventions to ensure code quality and readability.

More information

For more information about contribution, design-choices, deployment and code quality, please refer to the folder docs in this repository.

Contributing to ACI Rental

We'd love for you to contribute to our source code and to make ACI Rental even better than it is today!

Here are the guidelines we'd like you to follow:

Issues and Bugs
Submission Guidelines
Contributing as an 'insider'
Contributing as an 'outsider'
Getting started
Coding Format
More information

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to this repository. Even better you can submit a Pull Request with a fix.

Submission Guidelines

Submitting an Issue

If your issue appears to be a bug and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

Overview of the Issue - if an error is being thrown a non-minified stack trace helps
Reproduce the Error - provide details, if possible, on how to reproduce the error
Related Issues - has a similar issue been reported before?
Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Contributing as an 'insider'

Please follow the steps below when you are a member of this repository and would like to contribute.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Make a branch with the following conventions:
- Issue for the bug or feature exists
- Starts with the number of the issue
- Branch is based on dev
- Ex: 45-add-rental-page or 46-fix-login-null-exception
Create your patch and run/create the appropriate tests
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: “change” not “changed” nor “changes”.
```
git commit -a
```
Note: the optional commit -a command line option will automatically “add” and “rm” edited files.
Push your branch to GitHub:
```
git push origin 45-add-rental-page
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. 45-add-rental-page).
Push the changes to your branch (this will update your Pull Request). If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

Contributing as an 'outsider'

Please follow the steps below when you are not a member of this repository, but would still like to contribute to this project.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

Search the repositories for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Fork either the front-end, backend or both.

Clone your copy.

git clone https://github.com/YOUR_USERNAME/[front-end/backend].git
cd [front-end/backend]/

After cloning, set a new remote upstream (this helps to keep your fork up to date)
```
git remote add upstream https://github.com/ACI-Rental/[front-end/backend].git
```
Make your changes in a new git branch:
```
git checkout -b my-fix-branch dev
```
Create your patch and run appropriate tests.
Follow our Coding Format.
Commit your changes using a descriptive commit message that uses the imperative, present tense: "change" not "changed" nor "changes".
```
git commit -a
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```

In GitHub, send a pull request to [front-end/backend]:dev. If we suggest changes, then:

Make the required updates.
Re-run the application and make sure any and all tests are still passing.
Commit your changes to your branch (e.g. my-fix-branch).
Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git fetch upstream
git rebase upstream/dev
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
Check out the dev branch:
```
git checkout dev -f
```
Delete the local branch:
```
git branch -D my-fix-branch
```
Update your dev with the latest upstream version:
```
git pull --ff upstream dev
```

Getting started

Front-end

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information)

mkdir ACI && cd ACI
git clone https://github.com/ACI-Rental/front-end.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

mkdir ACI && cd ACI
git clone https://github.com/<YOUR_USERNAME>/front-end.git

After this, install all the packages:

npm install

After this the application can be started using:

npm run

Backend

Start out by cloning the repository: Insiders (please refer to Contributing as an 'insider' for more information):

cd ACI
git clone https://github.com/ACI-Rental/backend.git

Outsiders (please refer to Contributing as an 'outsider' for more information):

cd ACI
git clone https://github.com/<YOUR_USERNAME>/backend.git

After this the project can be started using Visual Studio or the dotnet command line. To run multiple services:

Right click solution -> Startup project -> Mutliple startup projects -> set the desired microservices to 'Start'

Coding Format

Please read our code conventions to ensure code quality and readability.

More information

For more information about contribution, design-choices, deployment and code quality, please refer to the folder docs in this repository.

Files

CONTRIBUTING.md

Latest commit

History

CONTRIBUTING.md

File metadata and controls

Contributing to ACI Rental

Found an Issue?

Submission Guidelines

Submitting an Issue

Contributing as an 'insider'

Submitting a Pull Request

Contributing as an 'outsider'

Submitting a Pull Request

After your pull request is merged

Getting started

Front-end

Backend

Coding Format

More information

Contributing to ACI Rental

Found an Issue?

Submission Guidelines

Submitting an Issue

Contributing as an 'insider'

Submitting a Pull Request

Contributing as an 'outsider'

Submitting a Pull Request

After your pull request is merged

Getting started

Front-end

Backend

Coding Format

More information

Contributing to ACI Rental

Found an Issue?

Submission Guidelines

Submitting an Issue

Contributing as an 'insider'

Submitting a Pull Request

Contributing as an 'outsider'

Submitting a Pull Request

After your pull request is merged

Getting started

Front-end

Backend

Coding Format

More information