Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

01. How to contribute

Ilkka Seppälä edited this pageMar 30, 2025 ·63 revisions

Issues

First, check out theproject andissue tracker to find something interesting to do. Issues not in progress and with the labelhelp wanted are the ones where we need assistance. Of course, you may have detected something we don't know yet, so feel free to raise your own issue. If you are a first-time contributor, it's probably best to start with something easy - so look for issues with labelgood first issue.

IDE instructions

How to setup IDE for this project is described inhttps://github.com/iluwatar/java-design-patterns/wiki/12.-IDE-instructions

New pattern

To work on a new pattern you need to do the following steps:

  1. If there is no issue with the new pattern yet, raise a new issue. Comment on the issue that you are working on so that others don't start working on the same thing. You are encouraged to present your implementation idea so others can participate in the design phase and help. Read through the pages in this Wiki to better understand what is required from the implementation. Ensure that the code conforms with thetechnology selections. Familiarize yourself with some of the existing pattern implementations to deepen your understanding.
  2. Fork the repository.
  3. Create a new folder for the pattern. The rough structure of the new folder would be as follows:
    • etc (every resource related to the pattern, like diagrams)
    • src (the source code of the pattern)
    • README.md (the description of the pattern)
    • pom.xml (the Maven project file)
  4. Include your module in the parent pom.xml
  5. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. Reference the issue id e.g. #52 in your commit messages.
  6. Use Spotless Maven plugin to format the code according to Google style. The build fails if the code is not properly formatted. Seecoding conventions.
  7. Add a description of the pattern in pattern'sREADME.md. All internal links must be relative to the pattern subdirectory or otherwise, the links don't link properly on the website. All code samples need to be annotated with correct language for the syntax highlighting to work e.g. ```java xxx ```
  8. Create a pull request. We use a checklist for reviewing new patterns. Check out the guidelineshere..

Structure of the pattern'sREADME.md file is described on pagePattern template

If needed,how to add a new category or tag is described on pageCategories and Tags

Non-pattern Issue

To work on one of the non-pattern issues you need to do the following steps:

  1. Check that the issue is not yet in progress and hashelp wanted label
  2. Comment on the issue that you are working on it so that others don't work on the same thing. The maintainers will then assign the issue for you.
  3. Fork the repository.
  4. Implement the code changes in your fork. Remember to add sufficient comments documenting the implementation. Reference the issue id e.g. #52 in your commit messages.
  5. Create a pull request.
Clone this wiki locally

[8]ページ先頭

©2009-2025 Movatter.jp