Skip to content

Commit df4c9a8

Browse files
authored
Create CONTRIBUTING.md
1 parent 779aea9 commit df4c9a8

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

CONTRIBUTING.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
## Contributing
2+
3+
First off, thank you for considering contributing to Active Admin. It's people
4+
like you that make Active Admin such a great tool.
5+
6+
### 1. Where do I go from here?
7+
8+
If you've noticed a bug or have a question,
9+
[search the issue tracker](https://github.com/irontec/android-kotlin-samples/issues?q=something)
10+
to see if someone else has already created a ticket.
11+
If not, go ahead and [make one](https://github.com/irontec/android-kotlin-samples/issues/new)!
12+
13+
### 2. Fork & create a branch
14+
15+
If this is something you think you can fix, then
16+
[fork](https://help.github.com/articles/fork-a-repo)
17+
and create a branch with a descriptive name.
18+
19+
A good branch name would be (where issue #7 is the ticket you're working on):
20+
21+
```sh
22+
git checkout -b 7-new-fix-for-fancy-functionality
23+
```
24+
25+
#### 3. Did you find a bug?
26+
27+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/irontec/android-kotlin-samples/issues).
28+
29+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/irontec/android-kotlin-samples/issues/new).
30+
Be sure to include a **title and clear description**, as much relevant information as possible,
31+
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
32+
33+
* If possible, use the relevant bug report templates to create the issue.
34+
Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue,
35+
and **paste the content into the issue description**:
36+
37+
### 4. Implement your fix or feature
38+
39+
At this point, you're ready to make your changes! Feel free to ask for help;
40+
everyone is a beginner at first :smile_cat:
41+
42+
### 5. Make a Pull Request
43+
44+
At this point, you should switch back to your master branch and make sure it's
45+
up to date with Active Admin's master branch:
46+
47+
```sh
48+
git remote add upstream git@github.com:irontec/android-kotlin-samples.git
49+
git checkout master
50+
git pull upstream master
51+
```
52+
53+
Then update your feature branch from your local copy of master, and push it!
54+
55+
```sh
56+
git checkout 7-new-fix-for-fancy-functionality
57+
git rebase master
58+
git push --set-upstream origin 7-new-fix-for-fancy-functionality
59+
```
60+
61+
Finally, go to GitHub and
62+
[make a Pull Request](https://help.github.com/articles/creating-a-pull-request)
63+
:D
64+
65+
### 6. Keeping your Pull Request updated
66+
67+
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
68+
has changed, and that you need to update your branch so it's easier to merge.
69+
70+
To learn more about rebasing in Git, there are a lot of
71+
[good](http://git-scm.com/book/en/Git-Branching-Rebasing)
72+
[resources](https://help.github.com/articles/interactive-rebase),
73+
but here's the suggested workflow:
74+
75+
```sh
76+
git checkout 7-new-fix-for-fancy-functionality
77+
git pull --rebase upstream master
78+
git push --force-with-lease 7-new-fix-for-fancy-functionality
79+
```

0 commit comments

Comments
 (0)