3.7 KiB

Исходник Постоянная ссылка Ответственный История

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

Local development

If you want to try the latest package locally without installing it from npm, use the following instructions. This may be useful when you want to try the latest non published version of this library or you want to make a contribution.

Follow the instructions for checking and updating the Angular CLI version. Also, verify your of TypeScript is version 3.4.5 or greater.

npm link

Use the following instructions to make ng-deploy-azure available locally via npm link.

Clone the project

git clone git@github.com:Azure/ng-deploy-azure.git
cd ng-deploy-azure

Install the dependencies
```
npm install
```
Build the project:
```
npm run build
```
Create a local npm link:
```
npm link
```

Adding to an Angular project - ng add

Once you have completed the previous steps to npm link the local copy of ng-deploy-azure, follow these steps to use it in a local angular project.

Enter the project's directory
```
cd your-angular-project
```
To add the local version of @azure/ng-deploy, link ng-deploy-azure.
```
npm link ng-deploy-azure
```
You may be prompted you to sign in to Azure, providing a link to open in your browser and a code to paste in the login page.
Then, running ng add @azure/ng-deploy will use the locally linked version.
```
ng add @azure/ng-deploy
```
Now you can deploy your angular app to azure.
```
ng run your-angular-project:deploy
```

You can remove the link later by running npm unlink

Testing

Testing is done with Jest. To run the tests:

npm run test:jest

Commits message

This project follows the Conventional Commits convention, meaning that your commits message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer]

The commit should contains the following structural elements:

fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
BREAKING CHANGE: a commit that has the text BREAKING CHANGE: at the beginning of its optional body or footer section introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
Others: commit types other than fix: and feat: are allowed such as chore:, docs:, style:, refactor:, perf:, test:.

If you are new to this convention you can use npm run commit instead of git commit and follow the guided instructions.

Pull requests

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

3.7 KiB Исходник Постоянная ссылка Ответственный История