blob: f9f0f40eff4ae06cf80a17045496e83cdd9f0583 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="NAV_LINK" content="Guidelines">
<meta name="NAV_PRIORITY" content="8">
<title>Developer Guidelines</title>
<link rel="stylesheet" type="text/css"
href="https://netbeans.org/netbeans.css">
</head>
<body>
<h1>Developer Guidelines</h1>
<p>Developers contributing to the NetBeans project are expected to
follow a common set of guidelines simplifying standard
procedures and ensuring that all developers working on NetBeans are
able to work together. Please see the
following topics:</p>
<p><a
href="https://platform.netbeans.org/articles/installation.html">Installation
Structure</a>:
It is intended as a quick guide to the directory structure of an
application
based on the NetBeans platform. It is important to understand this
structure especially when you are deciding which JAR files
should be placed into which subdirectory, where to put items
on the file system, etc.</p>
<p><a href="https://netbeans.org/community/guidelines/commit.html">CVS Commit Rules</a>:
Commits to the CVS repository should be done with care - here's
how to check and validate your changes before commiting.
</p>
<p><a href="https://netbeans.org/community/guidelines/q-evangelism.html">Q-Evangelism</a>:
Discover benefits of writing unit tests and using various tools for
finding bugs by reading
this document. It's the description of tools Netbeans developers can
use for increasing the
quality of our codebase and it's also the summary of reasons why one
should write unit tests.
<!--
<p><a href="https://netbeans.org/community/guidelines/process.html">Release Process</a>:
If you are intested in how new versions of the NetBeans IDE
are released, this is the place. Find information about the
release process, Release Coordinator and their
responsibilities.</p>
--></p>
<p><a href="https://netbeans.org/community/guidelines/code-conventions.html">Code Conventions</a>:
Formatting, programming practices, and other conventions used in the
NetBeans codebase.
</p>
<p><a
href="https://netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">Branding
&amp; I18N</a>:
This document provides recommendations on how to organize I18N
(localization) of modules in the NetBeans IDE. Other topics
include I18N features, bundle messages, bundle debugging, how
to write better *.properties files, templates, help
documentation, branded localization and more.</p>
<p><a href="https://netbeans.org/community/guidelines/checklist.html">Release Checklist</a>:
Find information regarding checklist for creating a release
branch, checklist for making a release and checklist for a
volunteer Release COordinator.</p>
<p><a href="https://netbeans.org/community/guidelines/au-management.html">AutoUpdate Content Management Process</a>:
A description of the guidelines for managing the content of the
NetBeans AutoUpdate servers - the process for adding and removing
modules.
</p>
<p><a href="http://openide.netbeans.org/tutorial/review-steps.html">API
Review Process</a>:
A description of the guidelines on reviewing the APIs -
from proposing a change through to implementing it.
</p>
<p><!-- XXX new link? --><a
href="https://netbeans.org/download/dev/javadoc/OpenAPIs/org/openide/doc-files/upgrade.html">Module
Writer's Upgrade Guide</a>:
A module writer's upgrade guide - API changes you should be aware of,
changes you might need to make to your code, and tips to ensure the
best integration in the latest release.
</p>
</body>
</html>