diff options
| -rw-r--r-- | docs/CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | docs/GRE Coding Style.md (renamed from docs/UXP Coding Style.md) | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 031ddb904..c98a76f3b 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Code contribution guidelines
-To make sure code changes remain easy to organize, find and troubleshoot, please use the following guidelines when contributing code to the Pale Moon project (and UXP). These guidelines may, for some of you, sound tedious or more work than you'd prefer to put in, but keep in mind that a single paragraph of explanation with a code commit can save hours of work later on, and code comments can save your hide when trying to debug or improve code.
+To make sure code changes remain easy to organize, find and troubleshoot, please use the following guidelines when contributing code to the Pale Moon project (and GRE). These guidelines may, for some of you, sound tedious or more work than you'd prefer to put in, but keep in mind that a single paragraph of explanation with a code commit can save hours of work later on, and code comments can save your hide when trying to debug or improve code.
## General guideline for issues
@@ -39,7 +39,7 @@ For META issues it is important that discussion about specific implementation pa ## General guideline for submitting pull requests
-Most of our code changes will likely be submitted by collaborators from our community. This will be ported from other projects (e.g. Mozilla-based code) or new implementations, or a mix. The standard way of getting your code into Pale Moon or UXP is by way of creating a pull request against the master branch (trunk).
+Most of our code changes will likely be submitted by collaborators from our community. This will be ported from other projects (e.g. Mozilla-based code) or new implementations, or a mix. The standard way of getting your code into Pale Moon or GRE is by way of creating a pull request against the master branch (trunk).
A good pull request will:
- **Have an issue associated with it!** Even though GitHub offers very similar tools for PRs as it does for issues, any reasoning behind code commits in a PR have to be explained in an accompanying issue.
diff --git a/docs/UXP Coding Style.md b/docs/GRE Coding Style.md index fc025584f..f863d46a6 100644 --- a/docs/UXP Coding Style.md +++ b/docs/GRE Coding Style.md @@ -1,4 +1,4 @@ -# UXP Coding Style Guide +# GRE Coding Style Guide While our source tree is currently in a number of different Coding Styles and the general rule applies to adhere to style of surrounding code when you are making changes, it is our goal to unify the style of our source tree and making it adhere to a single style. This document describes the preferred style for new source code files and the preferred style to convert existing files to. |