Skip to content

Commit 14ec017

Browse files
authored
Update the docs now that we use github issues. (#4762)
* Update the docs now that we use github issues. * Update PULL_REQUEST_TEMPLATE fixed capitalization
1 parent 5ecd936 commit 14ec017

File tree

3 files changed

+8
-46
lines changed

3 files changed

+8
-46
lines changed

ISSUE_TEMPLATE.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
11
Hey there! Thanks for using Firefox!
22

3-
We prefer to have bugs in Bugzilla. That way issues can be tracked and the rest of Mozilla can help us fix and verify issues as well.
4-
5-
We would love if you have found a bug to report it in Bugzilla. [File a new bug](https://bugzilla.mozilla.org/enter_bug.cgi?bug_file_loc=http%3A%2F%2F&bug_ignored=0&op_sys=iOS%20&product=Firefox%20for%20iOS&rep_platform=All)
6-
7-
If you are having an issue building or running the project message us on IRC. There are lots of people who are around to help. We are on [#mobile](https://wiki.mozilla.org/IRC)
3+
If you are having issues with using Firefox make sure to check https://support.mozilla.org/en-US/products/ios first

PULL_REQUEST_TEMPLATE

+1-15
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
11
*Thank you for submitting a pull request, your contributions are greatly appreciated!*
22

33
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4-
## Pull Request Checklist
54

6-
- [ ] My patch has gone through review and I have addressed review comments
7-
- [ ] My patch has a standard commit message that looks like `Bug 12345678 - This fixes something something`
5+
Please make sure you've run the test scheme and all the tests pass. If your changes affect existing tests please make sure to update the tests as well.
86

9-
- [ ] I have updated the *Unit Tests* to cover new or changed functionality
10-
- [ ] I have updated the *UI Tests* to cover new or changed functionality
11-
- [ ] I have marked the bug with `[needsuplift]`
12-
- [ ] I have made sure that localizable strings use `NSLocalizableString()`
13-
14-
## Screenshots
15-
16-
If your patch includes user interface changes that you would like to suggest or that you would like UX to look at, please include them here.
17-
18-
## Notes for testing this patch
19-
20-
If useful, please leave notes for QA, explaining what this patch changes and how it can be best tested and verified.

README.md

+6-26
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Download on the [App Store](https://itunes.apple.com/app/firefox-web-browser/id9
66
This branch (master)
77
-----------
88

9-
This branch is for mainline development that will ship in *v15.0*.
9+
This branch is for mainline development that will ship in *v17.0*.
1010

11-
This branch only works with Xcode 10.0 and supports iOS 10.3 and above
11+
This branch only works with Xcode 10.1 and supports iOS 11.0 and above
1212

1313
This branch is written in Swift 4.2
1414

@@ -19,22 +19,12 @@ For bug fixes and features for a specific release use the version branch.
1919
Getting involved
2020
----------------
2121

22-
We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any kind of positive contribution. Please read the [Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/).
23-
24-
* IRC: [#mobile](https://wiki.mozilla.org/IRC) for general discussion and [#mobistatus](https://wiki.mozilla.org/IRC) for team status updates.
25-
* Mailing list: [mobile-firefox-dev@mozilla.org](https://mail.mozilla.org/listinfo/mobile-firefox-dev).
26-
* Bugs: [File a new bug](https://bugzilla.mozilla.org/enter_bug.cgi?bug_file_loc=http%3A%2F%2F&bug_ignored=0&op_sys=iOS%20&product=Firefox%20for%20iOS&rep_platform=All)[Existing bugs](https://bugzilla.mozilla.org/describecomponents.cgi?product=Firefox%20for%20iOS)
27-
28-
Want to contribute but don't know where to start? Here is a list of [Good First Bugs.](http://www.joshmatthews.net/bugsahoy/?mobileios=1&simple=1)
29-
30-
Likewise, the design and UX is still in flux. Don't get attached to them. They will change tomorrow!
31-
32-
*GitHub issues are enabled* on this repository, but we encourage you to file a bug (see above). We'll accept issues to track work items that don't yet have a pull request, and also as an early funnel for bug reports, but Bugzilla is the source of truth for lots of good reasons — issues will be shifted into Bugzilla, and pull requests need a bug number.
22+
Want to contribute but don't know where to start? Here is a list of [issues that are contributor friendly](https://github.com/mozilla-mobile/firefox-ios/issues?q=is%3Aissue+is%3Aopen+label%3A%22Contributor+OK+%F0%9F%A4%9D%22)
3323

3424
Building the code
3525
-----------------
3626

37-
> __As of Oct 2018, this project requires Xcode 10.__
27+
> __As of Oct 2018, this project requires Xcode 10.1__
3828
3929
1. Install the latest [Xcode developer tools](https://developer.apple.com/xcode/downloads/) from Apple.
4030
1. Install Carthage
@@ -87,22 +77,12 @@ npm run build
8777
## Contributor guidelines
8878
8979
### Creating a pull request
90-
* All pull requests must be associated with a specific bug in [Bugzilla](https://bugzilla.mozilla.org/).
91-
* If a bug corresponding to the fix does not yet exist, please [file it](https://bugzilla.mozilla.org/enter_bug.cgi?op_sys=iOS&product=Firefox%20for%20iOS&rep_platform=All).
92-
* You'll need to be logged in to create/update bugs, but note that Bugzilla allows you to sign in with your GitHub account.
93-
* Use the bug number/title as the name of pull request. For example, a pull request for [bug 1135920](https://bugzilla.mozilla.org/show_bug.cgi?id=1135920) would be titled "Bug 1135920 - Create a top sites panel".
94-
* Finally, upload an attachment to the bug pointing to the GitHub pull request.
95-
1. Click <b>Add an attachment</b>.
96-
2. Next to <b>File</b>, click <b>Paste text as attachment</b>.
97-
3. Paste the URL of the GitHub pull request.
98-
4. Enter "Pull request" as the description.
99-
5. Finally, flag the pull request for review. Set the <b>review</b> field to "?", then enter the name of the person you'd like to review your patch. If you don't know whom to add as the reviewer, click <b>suggested reviewers</b> and select a name from the dropdown list.
100-
101-
<b>Pro tip: To simplify the attachment step, install the [Github Bugzilla Tweaks](https://github.com/autonome/Github-Bugzilla-Tweaks) addon. This will add a button that takes care of the first four attachment steps for you.</b>
80+
* All pull requests must be associated with a specific Issue. If an issue doesn't exist please first create it.
10281
10382
### Swift style
10483
* Swift code should generally follow the conventions listed at https://github.com/raywenderlich/swift-style-guide.
10584
* Exception: we use 4-space indentation instead of 2.
85+
* This is a loose standard. We do our best to follow this style
10686
10787
### Whitespace
10888
* New code should not contain any trailing whitespace.

0 commit comments

Comments
 (0)