Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WIP

 

Table of Contents
 

Getting ready to contribute to NetBeans

Bootstrapping (need to be done only once)

...

git config --global user.name "John Doe"
git config --global user.email "john@doe.org"

--global  can be removed if you want to setup only the current repository.

 

Also add the Apache NetBeans incubator project as your upstream in order to submit PRs

git remote add upstream https://github.com/apache/incubator-netbeans.git

Use branches

You now want to create a Pull Request for a fix or a new feature. Pull Request are not fixed in time. I you change your history the PR will be impacted.

...

After submission (and certainly after someone starts reviewing the PR) you shouldn't touch the PR's history.

 

Keeping your own fork in sync with Apache GitHub repo

<to be described :  possible link we can use: https://help.github.com/articles/syncing-a-fork/>

...

git fetch upstream
git checkout master

...

When submitting a PR keep in mind these principles:

  1. Please submit an issue to JIRA (https://issues.apache.org/jira/projects/NETBEANS/summary) explaining your setup (platform, tc.), why your PR is needed and a case to reproduce, if possible.
  2. In the code, try Try to be concise and right to the point. Just modify whatever needs to be modified to solve the issue at hand.
  3. If your code is complex:
    1.  submit a unit test as well.
    2.  add comments for the most complex parts.
  4. Try to keep the code readable, maintainable, easy to debug and performant.
  5. When submitting a PR start your commit message with NETBEANS-XYZ, where XYZ is the issue number. By doing so your PR will be automatically associated to the JIRA issue.

Streaming API considerations

...