-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# CONTRIBUTING | ||
|
||
### Method of adding changes | ||
|
||
Changes will be added via branching: | ||
|
||
* Create a new branch with a descriptive name, followed by _ and initials, (for example: contributing_AG). | ||
* Make all changes in this branch, and commit and push your changes. | ||
* When the branch is ready to merge, open a pull request for the merge, tagging the other two contributors. | ||
* Once this issue is raised STOP working in this branch until the issue is resolved. | ||
* Either of the other contributors has full authority to merge changes. | ||
* When a branch is merged in with the Master, that branch should be immediately deleted. | ||
|
||
### Raising Issues | ||
|
||
Please raise an issue for any and all things! As a courtesy, please tag all of the contributors. | ||
|
||
### Commit Messages | ||
|
||
Remember that commit messages are the way to remember what was done, and keep messages meaningful. | ||
|
||
### Directory Structure | ||
|
||
Keep all documents in the correct folder, when in doubt, ask the other contributors (perhaps in an issue?). Remember to cite any sources in the `doc\references\README.md`, which documents any citations. | ||
|
||
|
||
### Git Commands | ||
|
||
1. Create a new branch | ||
``` | ||
git branch -b [BRANCH NAME] | ||
``` | ||
2. After completing some tasks: | ||
1. Add *all* files that have been worked on | ||
``` | ||
git add . | ||
``` | ||
2. Add commit message | ||
``` | ||
git commit -m '[COMMIT MESSAGE]' | ||
``` | ||
3. Push from new branch for the first time | ||
``` | ||
git push --set-upstream origin [BRANCH NAME] | ||
``` | ||
4. Push anytime after that | ||
``` | ||
git push | ||
``` | ||
5. Navigate to [Compare changes](https://github.com/UBC-MDS/ptoolkit/compare) and create pull request for the branch of interest. | ||
6. Wait for a member of the team to merge [pull request](https://github.com/UBC-MDS/ptoolkit/pulls). | ||
3. If you need to update the branch that you are currently working in with the updated master branch: | ||
``` | ||
git pull origin master | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Code of Conduct | ||
|
||
As contributors to the P Toolkit project we: | ||
|
||
- Respect each other's opinions and ideas. | ||
- Accept the ideas from anyone interested in contributing to this project. | ||
- Communicate using a respectful language. Any comment, issue or interaction with an offensive language of tone will be removed. | ||
- Cite our sources and give attribution to the author/s for all the content used for building this package. | ||
- Are compromised to make statistics more simple and fun for practitioners :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Master of Data Science at the University of British Columbia | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |