You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2017/05/17 19:07:18 UTC
[1/2] incubator-trafficcontrol git commit: modified contributing page
Repository: incubator-trafficcontrol
Updated Branches:
refs/heads/master 27102e67c -> 8d645a678
modified contributing page
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/cfb4695d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/cfb4695d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/cfb4695d
Branch: refs/heads/master
Commit: cfb4695d836eacb21754f5f19f128ada1e3987c9
Parents: 27102e6
Author: Ashish Timilsina <as...@comcast.com>
Authored: Wed May 17 14:40:56 2017 -0400
Committer: Jeremy Mitchell <mi...@gmail.com>
Committed: Wed May 17 13:06:49 2017 -0600
----------------------------------------------------------------------
CONTRIBUTING.md | 25 ++++++++++++++++++-------
1 file changed, 18 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/cfb4695d/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 38e292a..9e3e13a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,19 +1,31 @@
-How To Contribute
+**Contributing to Traffic Control**
=================
+Thanks again for your time and interest in this project!
+
+The following document is a set of guidelines to streamline the contribution process for our contributors. Please feel free to suggest changes to this document in a pull request!
+
+Things to know before getting started
+-------------------------------------
+
+#### Design Decisions
+When we need to make changes to the project, we first discuss it on the [users@trafficcontrol.incubator.apache.org](mailto:users@trafficcontrol.incubator.apache.org) mailing list. We document our decisions as well as brainstorm project related ideas in the [wiki](https://cwiki.apache.org/confluence/display/TC/Traffic+Control+Home).
+
+How to Contribute
+-------------------------------------
+
We love pull requests! We simply don't have the time or resources to add every feature and support every platform. If you have improvements (enhancements or bug fixes) for Traffic Control, start by creating an [issue](https://issues.apache.org/jira/browse/TC) and discussing it with us first on the [users@trafficcontrol.incubator.apache.org](mailto:users@trafficcontrol.incubator.apache.org) mailing list. We might already be working on it, or there might be an existing way to do it.
Once your issue has been approved and you're ready to start slinging code, we have a few [guidelines](https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md#guidelines) to help maintain code quality and ensure the pull request process goes smoothly.
Remember, your code doesn't have to be perfect. Hack it together and submit a [pull request](https://help.github.com/articles/using-pull-requests/). We'll work with you to make sure it fits properly into the project.
-Making a pull request
----------------------
+#### Making a pull request
If you've never made a pull request, it's super-easy. Github has a great tutorial [here](https://help.github.com/articles/using-pull-requests/). In a nutshell, you click the _fork_ button to make a fork, clone it and make your change, then click the green _New pull request_ button on your repository's Github page and follow the instructions. That's it! We'll look at it and get back to you.
Guidelines
----------
-Following the project conventions will make the pull request process go faster and smoother. If making changes to the Traffic Ops API, please consult the [Traffic Ops API Guidelines](https://github.com/Comcast/traffic_control/wiki/Traffic-Ops-API-Guidelines-v1.x).
+Following the project conventions will make the pull request process go faster and smoother. If making changes to the Traffic Ops API, please consult the [Traffic Ops API Guidelines](https://cwiki.apache.org/confluence/display/TC/API+Guidelines).
#### Create an issue
@@ -31,7 +43,7 @@ Keep functions small. Big functions are hard to read, and hard to review. Try to
#### One pull request per feature
-Like big functions, big pull requests are just hard to review. Make each pull request as small as possible. For example, if you're adding ten independent API endpoints, make each a separate pull request. If you're adding interdependent functions or endpoints to multiple components, make a pull request for each, starting at the lowest level.
+Like big functions, big pull requests are just hard to review. Make each pull request as small as possible. For example, if you're adding ten independent API endpoints, make each a separate pull request. If you're adding interdependent functions or endpoints to multiple components, make a pull request for each, starting at the lowest level.
#### Tests
@@ -44,7 +56,6 @@ We're in the process of adding more tests and testing frameworks, so if a testin
#### Commit messages
Try to make your commit messages follow [git best practices](http://chris.beams.io/posts/git-commit/).
-
1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
@@ -53,7 +64,7 @@ Try to make your commit messages follow [git best practices](http://chris.beams.
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
-This make it easier for people to read and understand what each commit does, on both the command line interface and Github.com.
+This makes it easier for people to read and understand what each commit does, on both the command line interface and Github.com.
---
[2/2] incubator-trafficcontrol git commit: This closes #584
Posted by mi...@apache.org.
This closes #584
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/8d645a67
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/8d645a67
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/8d645a67
Branch: refs/heads/master
Commit: 8d645a678045e888bc17343b49f907baea90b3cd
Parents: cfb4695
Author: Jeremy Mitchell <mi...@gmail.com>
Authored: Wed May 17 13:07:12 2017 -0600
Committer: Jeremy Mitchell <mi...@gmail.com>
Committed: Wed May 17 13:07:12 2017 -0600
----------------------------------------------------------------------
----------------------------------------------------------------------