├── SCHEDULE.md ├── RULES.md ├── SPRINT.md ├── GIT.md └── README.md /SCHEDULE.md: -------------------------------------------------------------------------------- 1 | # Schedule 2 | 3 | ## Jubilee 1 4 | 5 | ### [Fermat](https://github.com/JordanRL/Fermat) 6 | 7 | - **Jubilee Lead:** [@JordanRL](https://github.com/JordanRL) 8 | - **Fork Date:** November 10th, 2015 9 | - **Start Date:** November 12th, 2015 10 | - **End Date:** November 26th, 2015 11 | -------------------------------------------------------------------------------- /RULES.md: -------------------------------------------------------------------------------- 1 | # Rules For The Jubilees 2 | 3 | Below are a list of rules to help promote the core tenets of the project. 4 | 5 | - Before a branch can be used for a PR into the original repository, at least **two** other members have to give the branch a :+1: in the relevant issue. 6 | - Until the last two days of the Jubilee, please make sure that everyone gets a chance to finish an issue if they want to. During the last two days, anyone may reassign an issue to themselves if the person working on it won't get it finished in time. 7 | - Be helpful, and answer questions. Any time a member encounters something they don't know, teach them how to do it if you can, don't try to do it for them if possible. 8 | - Respect the wishes of the original repository owner. 9 | -------------------------------------------------------------------------------- /SPRINT.md: -------------------------------------------------------------------------------- 1 | # Sprint Process 2 | 3 | S = Start Date 4 | E = End Date 5 | 6 | ## Start -2 Days 7 | 8 | The repository for the project is forked into the PHPJubilee organization. 9 | 10 | ## S-2 - S 11 | 12 | The repository is prepped with all of the custom labels that we will be using, and initial issue reporting can occur. Any issues open in the original repository that we intend to close will be copied at this time. 13 | 14 | ## S - S+2 15 | 16 | The group looks through the codebase and identifies problems or improvements that can be made, creating the issues for them. The Jubilee lead (the person leading that sprint) makes sure they are all labeled. 17 | 18 | ## S+2 (Will always be a Saturday) 19 | 20 | The Jubilee lead gives each open issue at least one label for a team (each team will have a label in the repository). Each team should try to close all of their issues before moving on to helping other teams, if possible. 21 | 22 | ## S+2 - S+10 23 | 24 | Development! We all buckle in and try to make as much improvement, and forgive as much technical debt as we can. 25 | 26 | ## S+10 - E 27 | 28 | Pull requests are made from each feature branch into the original project. Be sure to communicate with the person maintaining the original project if they have notes or changes in the pull request that need to be addressed before the pull request can be merged. 29 | -------------------------------------------------------------------------------- /GIT.md: -------------------------------------------------------------------------------- 1 | # GIT 2 | 3 | ## Branching Strategy 4 | 5 | ### Source of truth 6 | 7 | The "source of truth" for the codebase will always be the dev branch of the original project. For some projects, this is actually the `master` branch, others use `dev`, and others use something else. 8 | 9 | **No commits will ever be made to this branch, and no pull requests will be made into that branch on our fork unless the pull request has already been merged with the original repository.** 10 | 11 | This is so that we can: 12 | 13 | - Always have a "clean" branch to start a new feature from. 14 | - Merge in changes in the dev branch made to the original project, to keep ours up to date as we develop. 15 | 16 | ### Feature Branches 17 | 18 | Before starting work on a new issue, you always first: 19 | 20 | ``` 21 | git checkout SOURCEOFTRUTH 22 | git pull 23 | ``` 24 | 25 | This ensures you are always starting from the most up-to-date point. Then: 26 | 27 | ``` 28 | git checkout -b FEATURE 29 | ``` 30 | 31 | FEATURE will be replaced with the feature branch name for your issue. This will be in the format: 32 | 33 | ``` 34 | f-###-DESC 35 | ``` 36 | 37 | Where ### is the issue number you are working on, and DESC is some word or short phrase that describes the goal or work. 38 | 39 | It's very important that the branches are named correctly, so that we don't accidentally have two developers name their branches the same and then do different work. 40 | 41 | ## GIT Practices 42 | 43 | ### Commits 44 | 45 | #### Commit Comments 46 | 47 | Everyone should get out of the habbit of using the -m option on the `git commit` command. Most of the time, commit messages *should* be very detailed. The only times you will ever actually use commit messages, you very much want them to be detailed. 48 | 49 | Using `git commit` without the -m option will force you to use the multi-line message tool (nano by default on Ubuntu), which makes it easier to be more detailed. 50 | 51 | #### Workflow in Commit Comments 52 | 53 | The commit which closes your ticket should END with [closes #4] or something similar, where 4 is replaced by the issue number in that repo. The octothorp (#) character needs to go in front of the number. 54 | 55 | If you do this, the issue will automatically close once that commit makes it into the default branch. 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PHPJubilee 2 | 3 | ### *Forgiving technical debt, two weeks at a time* 4 | 5 | ## Next Jubilee: [Fermat](https://github.com/JordanRL/Fermat) | Fork: Nov 10th | Starts: Nov 12th 6 | 7 | Join our online chat at [![PHPJubilee](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/PHPJubilee?utm_source=share-link&utm_medium=link&utm_campaign=share-link) or at ![PHPJubilee](https://img.shields.io/badge/irc.freenode.net-%23PHPJubilee-blue.svg) 8 | 9 | ## What is the Jubilee? 10 | 11 | It is fairly common to see this constellation of issues come up in the PHP developer community: 12 | 13 | - "I'm not a Junior dev, but I don't know where to start when it comes to contributing to projects." 14 | - "I don't know what projects need what help, or how to find them." 15 | - "I'm still learning PHP. I want to work on an open source project to help learn, but don't know the 'good' from the 'bad'." 16 | - "I have a project that I would like help on, but don't know where to find it." 17 | 18 | The group will decide from [a list of PHP projects](https://github.com/PHPJubilee/Project/issues/1) a new project to contribute to every two weeks. 19 | 20 | Every two weeks, the org will fork the new repo on github. Everyone that has joined the org will have write access to the forked repo. They will of course also be able to fork it themselves if they want, but particularly because this could be helpful for novice developers that want a way to get their feet wet, development should primarily be from the Org's fork. 21 | 22 | Each user will create their own feature branch, the org will create it's own issues list and assign them out, and we will provide the project maintainer with one pull request per issue we close (on our end). 23 | 24 | The whole idea of this would be to roll through the PHP community and for one project every two weeks "forgive their technical debt": thus, Jubilee. 25 | 26 | ## What sort of things will the group try to do? 27 | 28 | The kinds of things that we would (primarily) be looking to help with, in order of importance: 29 | 30 | 1. Helping the project close existing bug issues. 31 | 2. Helping to report (and fix if possible) new bug issues. 32 | 3. Increasing unit test coverage, and improving the quality of those tests. 33 | 4. Ensuring that the code has DocBlock comments so that IDEs can work easily with the project. 34 | 5. Identify areas of the project that need to be fixed for best practices & coding style (as specified by the project itself). 35 | 36 | ## Other Important Information 37 | 38 | [Jubilee Project Schedule](SCHEDULE.md) | [Sprint Process](SPRINT.md) | [GIT Practices & Branching Strategy](GIT.md) 39 | 40 | ## How can I join as a developer? 41 | 42 | Leave a comment [here](https://github.com/PHPJubilee/Project/issues/2). 43 | 44 | ## How can I suggest a project? 45 | 46 | By leaving a link to it [here](https://github.com/PHPJubilee/Project/issues/1). It must be on github, and must be open source. 47 | --------------------------------------------------------------------------------