You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 31, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ This document provides general guidelines about how to contribute to the project
5
5
6
6
### Asking Questions
7
7
8
-
We do not use github issues for general library support. We think this questions should be posted on stack overflow using [InstantSearch](http://http://stackoverflow.com/questions/tagged/InstantSearch) tag.
8
+
We do not use GitHub issues for general library support. We think these questions should be posted on Stack Overflow using [InstantSearch](http://http://stackoverflow.com/questions/tagged/InstantSearch) tag.
9
9
10
10
### Reporting issues
11
11
12
12
* Use [github issues](https://github.com/algolia/InstantSearch/issues) to report a bug.
13
13
* Before creating a new issue:
14
14
* Make sure you are using the [latest release](https://github.com/algolia/InstantSearch/releases).
15
15
* Check if the issue was [already reported or fixed](https://github.com/algolia/InstantSearch/issues?utf8=%E2%9C%93&q=is%3Aissue). Notice that it may not be released yet.
16
-
* If you found a match add a brief comment "I have the same problem" or "+1". This helps prioritize the issues addressing the most common and critical first. If possible add additional information to help us reproduce and fix the issue. Please use your best judgement.
16
+
* If you found a match add a brief comment "I have the same problem" or use the action `+1`. This helps prioritize the issues addressing the most common and critical first. If possible add additional information to help us reproduce and fix the issue. Please use your best judgement.
17
17
* Reporting issues:
18
18
* Please include the following information to help maintainers to fix the problem faster:
19
19
* Xcode version you are using.
@@ -24,20 +24,20 @@ We do not use github issues for general library support. We think this questions
24
24
25
25
### Pull requests
26
26
27
-
The easiest way to start contributing is searching open issues by `help wanted` tag. We also add a `difficulty` tag (difficulty: easy, difficulty: moderate, difficulty: hard) in order to give an idea of how complex it can be to implement the feature according maintainers project experience.
27
+
The easiest way to start contributing is searching open issues by `help wanted` tag. We also add a `difficulty` tag (difficulty: easy, difficulty: moderate, difficulty: hard) in order to give an idea of how complex it can be to implement the feature according to maintainers' project experience.
28
28
29
29
* Add test coverage to the feature or fix. We only accept new feature pull requests that have related test coverage. This allows us to keep the library stable as we move forward.
30
30
* Remember to document the new feature. We do not accept new feature pull requests without its associated documentation.
31
31
* In case of a new feature please update the example project showing the feature.
32
-
* Please only one fix or feature per pull request. This will increase the chances your feature will be merged.
32
+
* Please only one fix or feature per pull request. This will increase the chances of your feature being merged.
33
33
34
34
35
35
###### Suggested git workflow to contribute
36
36
37
37
1. Fork the InstantSearch repository.
38
38
2. Clone your forked project into your developer machine: `git clone [email protected]:<your-github-username>/InstantSearch.git`
39
39
3. Add the original project repo as upstream repository in your forked project: `git remote add upstream [email protected]:algolia/InstantSearch.git`
40
-
4. Before starting a new feature make sure your forked master branch is synchronized upstream master branch. Considering you do not mere your pull request into master you can run: `git checkout master` and then `git pull upstream master`. Optionally `git push origin master`.
40
+
4. Before starting a new feature make sure your forked master branch is synchronized upstream master branch. Considering you do not merge your pull request into master you can run: `git checkout master` and then `git pull upstream master`. Optionally `git push origin master`.
41
41
5. Create a new branch. Note that the starting point is the upstream master branch HEAD. `git checkout -b my-feature-name`
42
42
6. Stage all your changes `git add .` and commit them `git commit -m "Your commit message"`
43
43
7. Make sure your branch is up to date with upstream master, `git pull --rebase upstream master`, resolve conflicts if necessary. This will move your commit to the top of git stack.
@@ -53,7 +53,7 @@ We try to follow our [swift style guide](https://github.com/algolia/Swift-Style-
53
53
54
54
### Feature proposal
55
55
56
-
We would love to hear your ideas and make a discussions about it.
56
+
We would love to hear your ideas and make a discussion about it.
57
57
58
58
* Use github issues to make feature proposals.
59
59
* We use `type: feature request` label to mark all [feature request issues](https://github.com/algolia/InstantSearch/labels/type%3A%20feature%20request).
0 commit comments