Skip to content
This repository has been archived by the owner on Mar 20, 2024. It is now read-only.

How to Contribute

Elana Olson edited this page Jun 22, 2018 · 17 revisions

We would love for you to contribute to AngularJS/Angular upgrade project and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

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

Questions and Answers

Here is where you can finally ask all those nitty gritty or general upgrade questions and have experts respond. The issues tab will be our questions and answers section. Any closed issue means we have concluded a good answer and any open means they still need an answer.

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to understand all the issues and often need code to understand your problem. In order to demonstrate your problem, we will systematically ask you to provide a minimal reproduction scenario using http://plnkr.co. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:

  • version of AngularJS used
  • 3rd-party libraries and their versions
  • and most importantly - a use-case that fails

A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If plunker is not a suitable way to demonstrate the problem, please create a standalone git repository demonstrating the problem.

We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

You can file new issues by filling out our new issue form.

Adding Documentation

This Wiki tab is where all documentation on upgrading, migration paths, available tools, and examples will live. Please follow the documentation guidelines below.

Since this is an opensource forum, it is up to you to add new features, tools, or documentation. We request that you follow our guidelines when adding new features and removing existing features. Please refer to the terminology and reasons for removing pages when adding or removing documents.

Terminology

Please do not vere from the standard terminologies used in this document. To provide a clear standard for how to refer to certain terms, please refer to the terminology page. Most common terms used are:

  • Angular: meaning for what is also known as ng2, Angular 2+, Angular 2, Angular 4, Angular 5, Angular 6.
  • AngularJS: meaning for what is also kown as ng1, Angular 1.

Glossary

We encourage you to add to the glossary each time you add a new documentation, whether it is a link to software, an article, or an opensource tool. This will help developers quickly find what they are looking for when searching through this upgrade forum.