1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
First off, thank you for considering contributing to JBoss Modules project. It's people like you that make JBoss Modules such a great library. JBoss Modules is an open source project and contributions from our community are more than welcome! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into JBoss Modules itself.
We expect all contributors and users to follow our [Code of Conduct](CODE_OF_CONDUCT.md) when communicating through project channels. These include, but are not limited to: chat, issues, code.
All recent development happens in the branch `main`. There are additional [branches](https://github.com/jboss-modules/jboss-modules/branches) mainly used for maintenance.
# One time setup
## Create a GitHub account
If you don't have one already, head to https://github.com/
## Fork JBoss Modules
Fork https://github.com/jboss-modules/jboss-modules into your GitHub account.
## Clone your newly forked repository onto your local machine
```bash
git clone git@github.com:[your username]/jboss-modules.git
cd jboss-modules
```
## Add a remote reference to upstream
This makes it easy to pull down changes in the project over time
```bash
git remote add upstream git://github.com/jboss-modules/jboss-modules.git
```
# Development Process
This is the typical process you would follow to submit any changes to JBoss Modules.
## Pulling updates from upstream
```bash
git pull --rebase upstream main
```
> Note that --rebase will automatically move your local commits, if you have
> any, on top of the latest branch you pull from.
> If you don't have any commits it is safe to leave off, but for safety it
> doesn't hurt to use it each time just in case you have a commit you've
> forgotten about!
## Discuss your planned changes (if you want feedback)
* JBoss Modules Issue Tracker - https://issues.redhat.com/browse/MODULES
* Zulip - https://wildfly.zulipchat.com/#narrow/stream/210170-jboss-modules
## Create a simple topic branch to isolate your work (recommended)
```bash
git checkout -b my_cool_feature
```
## Make the changes
Make whatever code changes, including new tests to verify your change, are necessary and ensure that the build and tests pass.
```bash
mvn clean install
```
> If you're making non code changes, the above step is not required.
## Commit changes
Add whichever files were changed into 'staging' before performing a commit:
```bash
git commit
```
## Rebase changes against main
Once all your commits for the issue have been made against your local topic branch, we need to rebase it against branch main in upstream to ensure that your commits are added on top of the current state of main. This will make it easier to incorporate your changes into the main branch, especially if there has been any significant time passed since you rebased at the beginning.
```bash
git pull --rebase upstream main
```
## Push to your repo
Now that you've synced your topic branch with upstream, it's time to push it to your GitHub repo.
```bash
git push origin my_cool_feature
```
## Getting your changes merged into upstream, a pull request
Now your updates are in your GitHub repo, you will need to notify the project that you have code/docs for inclusion.
* Send a pull request, by clicking the pull request link while in your repository fork
* After review a maintainer will merge your pull request, update/resolve associated issues, and reply when complete
* Lastly, switch back to branch main from your topic branch and pull the updates
```bash
git checkout main
git pull upstream main
```
* You may also choose to update your origin on GitHub as well
```bash
git push origin
```
## Some tips
Here are some tips on increasing the chance that your pull request is accepted:
* Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
* Include tests that fail without your code, and pass with it
# Issues
JBoss Modules uses JIRA to manage issues. All issues can be found [here](https://issues.redhat.com/projects/MODULES/issues).
To create a new issue, comment on an existing issue, or assign an issue to yourself, you'll need to first [create a JIRA account](https://issues.redhat.com/).
## Good First Issues
Want to contribute to JBoss Modules but aren't quite sure where to start? Check out our issues with the `good-first-issue` label. These are a triaged set of issues that are great for getting started on our project. These can be found [here](https://issues.redhat.com/browse/MODULES-1?jql=project%20%3D%20MODULES%20AND%20labels%20%3D%20good-first-issue).
Once you have selected an issue you'd like to work on, make sure it's not already assigned to someone else. To assign an issue to yourself, simply click on "Start Progress". This will automatically assign the issue to you.
|
