Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (60 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

90 lines (60 loc) · 4.1 KB

Contributing to NativeScript

👍 First of all, thank you for taking the time to contribute! 👍

Here are some guides on how to do that:

Reporting Bugs

  1. Always update to the most recent release; the bug may already be resolved.
  2. Search for similar issues in the issues list for this repo; it may already be an identified problem.
  3. If this is a bug or problem that is clear, simple, and is unlikely to require any discussion -- it is OK to open an issue on GitHub with a reproduction of the bug including workflows and screenshots. If possible, submit a Pull Request with a failing test, entire application or module. If you'd rather take matters into your own hands, fix the bug yourself (jump down to the Submitting a PR section).

While we are doing all we can to take care of every issue, sometimes we get overwhelmed. That's why

  • issues that are not constructive or describe problems that cannot be reproduced will be closed
  • feature requests or bug reports with unanswered questions regarding the behavior/reproduction for more than 20 days will be closed

Requesting Features

  1. Use Github Issues to submit feature requests.
  2. First, search for a similar request and extend it if applicable. This way it would be easier for the community to track the features.
  3. When requesting a new feature, please provide as much detail as possible about why you need the feature in your apps. We prefer that you explain a need rather than explain a technical solution for it. That might trigger a nice conversation on finding the best and broadest technical solution to a specific need.

Submitting a PR

Before you begin:

Following these steps is the best way to get you code included in the project:

  1. Fork and clone the NativeScript repo
git clone https://github.com/<your-git-username>/NativeScript.git
# Navigate to the newly cloned directory
cd NativeScript
# Add an "upstream" remote pointing to the original {N} repo.
git remote add upstream https://github.com/NativeScript/NativeScript.git
  1. Set up the project
#In the repo root
npm run setup
#View interactive options
npm start
  1. Create a branch for your PR
git checkout -b <my-fix-branch> main

  1. The fun part! Make your code changes.

  2. Before you submit your PR:

    • Rebase your changes to the latest main: git pull --rebase upstream main.
    • Ensure all unit test are green for Android and iOS. Check running unit tests.

  3. Push your fork. If you have rebased you might have to use force-push your branch:

git push origin <my-fix-branch> --force
  1. Submit your pull request. Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly.

It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks!

Commit Message Guidelines

Please follow standard conventional commit guidelines as outlined here: https://www.conventionalcommits.org/en/v1.0.0/. That allows us to use the commit messages to generate a changelog on releases.

Where to Start

If you want to contribute, but you are not sure where to start - look for issues labeled help wanted.