|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Thank you for considering a contribution to app-mod-sample! Please read the guidelines carefully. |
| 4 | + |
| 5 | +## Contributing prerequisites (CLA/DCO) |
| 6 | + |
| 7 | +The project does not yet define a Contributor License Agreement. By submitting pull requests submitters acknowledge they grant the [Apache License v2](./LICENSE) to the code and that they are eligible to grant this license for all commits submitted in their pull requests. |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +The `main` branch on this repository contains a traditional IBM WebSphere Application Server version of the application. All contributions to the `main` branch must be compatible with the application being deployed on IBM WebSphere Application Server 9 and using Java 8. |
| 12 | + |
| 13 | +The `liberty-java8` branch shows what the application looks like after modernizing to Liberty. |
| 14 | + |
| 15 | +The `liberty-java21` branch shows what the application looks like after modernizing to Liberty **AND** upgrading Java to Java 21. |
| 16 | + |
| 17 | +The `liberty-` branches must be kept consistent with the main branch. We want the branches to always reflect different stages of the modernization process. |
| 18 | + |
| 19 | + |
| 20 | +## Writing Pull Requests |
| 21 | + |
| 22 | +Contributions can be submitted by creating a pull request on Github. |
| 23 | +We recommend you do the following to ensure the maintainers can collaborate on your contribution: |
| 24 | + |
| 25 | +- Fork the project into your personal Github account |
| 26 | +- Create a new feature branch for your contribution |
| 27 | +- Make your changes |
| 28 | +- Open a PR with a clear description |
| 29 | + |
| 30 | +Contributors must include a Signed-off-by line in their commit message, to avoid having PRs blocked. Always include an email address that matches the |
| 31 | +commit author. For example: |
| 32 | + |
| 33 | +``` |
| 34 | +feat: this is my commit message |
| 35 | +
|
| 36 | +Signed-off-by: Author Name <authoremail@example.com> |
| 37 | +``` |
| 38 | + |
| 39 | +You can also do this automatically with `git`, by using the -s flag: |
| 40 | + |
| 41 | +``` |
| 42 | +$ git commit -s -m 'This is my commit message' |
| 43 | +``` |
| 44 | + |
| 45 | +## Code review process |
| 46 | + |
| 47 | +Once your pull request is submitted, a Project maintainer should be assigned to review your changes. |
| 48 | + |
| 49 | +The code review should cover: |
| 50 | + |
| 51 | +Contributors are expected to respond to feedback from reviewers in a constructive manner. |
| 52 | +Reviewers are expected to respond to new submissions in a timely fashion, with clear language if changes are requested. |
| 53 | + |
| 54 | +Once the pull request is approved, it will get merged. |
0 commit comments