Skip to content

Project Guidelines

Patrick Douglas edited this page Feb 18, 2017 · 5 revisions

Project Guidelines

Branching

Branches should be named according to the relevant feature they're being used for. For instance, for scheduler functionality, a branch could be named scheduler. For sub-features, or for individual modifications, branches should be named <username>/scheduler.

Code Reviews

For changes to branches other than master that are being shared by multiple people, it's strongly suggested to create a pull request and ensure that the code is reviewed by the other people working on the feature.

Deleting Branches

If you are responsible for a branch and the branch is no longer needed, you are responsible for deleting the branch. The repository should not have any more branches than are needed at a given time.

Git Commits

Please include descriptive messages with all commits, explaining what was changed.

Information To Include In Files

The top of every source code file should have the following information included:

/* 
 * Copyright (C) 2017  AltOS-Rust Team
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

Tagging Commits

Some commits are tagged with version information, starting with 1.0.0. The convention for a version is <major version>.<minor version>.<small changes> where a <major version> represents a larger change, such as the addition of entire new features, <minor version> changes include smaller adjustments or adjustments to existing features, and <small changes> represent very minor changes or bug fixes.

Clone this wiki locally