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 Aug 1, 2018 · 17 revisions

We would love for you to contribute to the ngMigration Forum and help make it even better! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Our Pledge

As contributors and maintainers of ngMigration Forum, we pledge to respect everyone who contributes by updating documentation, posting issues, providing feedback in comments, and any other activities.

Communication through any of upgrade channels (GitHub, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the ngMigration Forum to do the same.

If any member of the community violates this code of conduct, the maintainers of ngMigration Forum may take action, removing issues, comments, and documentation or blocking accounts as deemed appropriate.

If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at conduct@angular.io.

Q&A

The Questions & Answers section 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, an issue for your problem could already exist.

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

The 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 the below guidelines and terminology when adding new features.

Terminology

Angular is the name for the Angular of today and tomorrow.
AngularJS is the name for all 1.x versions of Angular.

New Tools, Articles, Talks, and Resources

  1. Include a link to the tool.
  2. A short (1-3) sentence description of what the tool does, who maintains it (open source or private), and use case for the tool.
Example

Angular.io is an open source guide to the Angular framework. It provides documentation, resources, a blog, and more supported by Google. Helpful to any web developer building a large or small Angular application.