Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

89 lines (68 loc) · 5.44 KB
Raw

Contributing to AzureMapsCodeSamples

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.

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 repos 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 [email protected] with any additional questions or comments.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.

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 the GitHub Repository. Even better, you can submit a Pull Request with a fix.

Want a Feature?

You can request a new feature by submitting an issue to the GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.

Submission Guidelines

Submitting an Issue

Before you submit an issue, search the archive, maybe your question was already answered.

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
  • Version - what version is affected (e.g. 0.1.2)
  • Motivation for or Use Case - explain what are you trying to do and why the current behavior is a bug for you
  • Browsers and Operating System - is this a problem with all browsers?
  • Reproduce the Error - provide a live example or a unambiguous set of steps
  • 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)

You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/Azure-Samples/AzureMapsCodeSamples/issues/new.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  • Search the repository (https://github.com/Azure-Samples/AzureMapsCodeSamples/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  • Make your changes in a new git fork:

  • Commit your changes using a descriptive commit message

  • Push your fork to GitHub:

  • In GitHub, create a pull request

  • If we suggest changes then:

    • Make the required updates.

    • Rebase your fork and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push -f

Requirements for adding a Sample

  • Fill the <title> tag of the sample with a discription title in the format "[Your Sample Title] - Azure Maps Web SDK Samples".
  • Add a short discription to the description meta tag. This is used to populate the description on the card and also a SEO optimization.
  • Add related keywords to the keyword meta tag. This is used for search and also a SEO optimization.
  • Create a screenshot of your sample that is 350px width and 225px tall and save it in the SiteResources/screenshots folder with the name of your sample but with spaces replaced with dashes. Alternatively run the SampleListBuilder app and it will attempt to capture a screenshot automatically. If your sample doesn't have a UI or not much of one, go into the SampleListBuilder/SampleListHelper.cs file and add the name of the sample to the ScreenshotsToIgnore list.
  • If you add a new category folder for samples, add it to CategoryFolders list with a short discription (will be dispayed on index.html) in the SampleListBuilder/SampleListHelper.cs file.
  • Ensure that all local URLs are relative (../) and not based off the root (/). This will ensure that the resource will be accessible if the sample file is openned in a browser directly without being hosted on localhost.
  • When you are done adding your sample, run the SampleListBuilder to update the index.html.
  • If you simple want to add a link to the external samples list, add it to the SampleListBuilder/SampleListHelper.cs file.
  • Be sure to remove your Azure Maps key before checking in.

That's it! Thank you for your contribution!