Skip to content

Commit 92e4e8e

Browse files
authoredFeb 18, 2022
Create contributing.md
1 parent b2b9639 commit 92e4e8e

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed
 

‎contributing.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contribution
2+
3+
This project welcomes contributions from the community. All contributions to this repository must be
4+
signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on
5+
as an open-source patch.
6+
7+
## Contribution Flow
8+
9+
This is a rough outline of what a contributor's workflow looks like:
10+
11+
- Create a topic branch from where you want to base your work
12+
- Make commits of logical units
13+
- Make sure your commit messages are in the proper format (see below)
14+
- Push your changes to a topic branch in your fork of the repository
15+
- Submit a pull request
16+
17+
Example:
18+
19+
``` shell
20+
git remote add upstream https://github.com/exajobs/<repos-name>
21+
git checkout -b my-new-feature master
22+
git commit -a
23+
git push origin my-new-feature
24+
```
25+
26+
### Staying In Sync With Upstream
27+
28+
When your branch gets out of sync with the exajobs/master branch, use the following to update:
29+
30+
``` shell
31+
git checkout my-new-feature
32+
git fetch -a
33+
git pull --rebase upstream master
34+
git push --force-with-lease origin my-new-feature
35+
```
36+
37+
### Updating pull requests
38+
39+
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
40+
existing commits.
41+
42+
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
43+
amend the commit.
44+
45+
``` shell
46+
git add .
47+
git commit --amend
48+
git push --force-with-lease origin my-new-feature
49+
```
50+
51+
If you need to squash changes into an earlier commit, you can use:
52+
53+
``` shell
54+
git add .
55+
git commit --fixup <commit>
56+
git rebase -i --autosquash master
57+
git push --force-with-lease origin my-new-feature
58+
```
59+
60+
Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
61+
notification when you git push.
62+
63+
### Code Style
64+
65+
### Formatting Commit Messages
66+
67+
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
68+
69+
Be sure to include any related GitHub issue references in the commit message. See
70+
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
71+
and commits.
72+
73+
## Reporting Bugs and Creating Issues
74+
75+
When opening a new issue, try to roughly follow the commit message format conventions above.

0 commit comments

Comments
 (0)
Please sign in to comment.