Вклад в cache2k

cache2k выпущен под лицензией Apache 2.0. Если вы хотите внести свой вклад или поработать над кодом, этот документ поможет вам начать работу.

Кодекс поведения

Этот проект придерживается кодекса поведения Contributor Covenant code of conduct. Участвуя в проекте, вы должны соблюдать этот кодекс.

Помогите, пожалуйста!

Есть много способов помочь проекту с открытым исходным кодом, помимо улучшения кодовой базы. Вот несколько идей:

• Просмотрите и улучшите документацию по проекту.
• Напишите статью в блоге.
• Если вам нравится cache2k или он решил конкретную проблему, рассмотрите возможность оставить отзыв на странице Happy Users Feedback issue.
• У cache2k есть много функций, иногда мы хотим изменить или удалить функцию и не знаем точно, от какой функции зависят пользователи. Пожалуйста, оставьте отзыв о том, как вы используете cache2k и какие функции вам полезны, на странице: Happy Users Feedback issue
• Задавайте вопросы об использовании на Stackoverflow. Это помогает другим пользователям и также продвигает проект.
• Протестируйте релизы .Alpha и .Beta на ранней стадии с вашей кодовой базой и отправьте отчёты об ошибках.

Вопросы об использовании

Если у вас есть общий вопрос об использовании, задайте его на Stack Overflow и используйте тег cache2k.

Если вы обнаружите ошибку в документации по коду или руководстве пользователя, рассмотрите возможность отправки запроса на извлечение с исправлением.

Использование проблем GitHub

Мы используем проблемы GitHub для отслеживания ошибок и улучшений. Если вы сообщаете об ошибке, пожалуйста, помогите ускорить диагностику проблемы, предоставив как можно больше информации. В идеале это должен быть небольшой пример проекта, который воспроизводит проблему.

Запросы на вытягивание

Запросы на вытягивание приветствуются. Пожалуйста, начните с небольших и простых запросов на вытягивание. Для отправки запроса на вытягивание необходимо подписать Developer Certificate of Origin.

Прежде чем отправлять тяжёлый, нетривиальный или сложный запрос на вытягивание, сначала откройте проблему и запросите отзывы других пользователей и участников на раннем этапе.

Вот несколько вещей, которые вы можете сделать, чтобы повысить вероятность принятия вашего запроса на вытягивание:

• Пишите и обновляйте тесты.
• Сделайте свои изменения максимально целенаправленными. Если есть несколько изменений, которые вы хотели бы внести и которые не зависят друг от друга, рассмотрите возможность отправить их в виде отдельных запросов на вытягивание.
• Напишите хорошее сообщение о фиксации.

Перед отправкой запроса на вытягивание проверьте, проходят ли все тесты, с помощью команды:

mvn verify

Требования к разработке

Проект работает на Java 8 и требует Java 11 для компиляции. Используемая версия maven должна быть 3.6.3 или выше. Проект можно импортировать в IntelliJ или Eclipse, выполнив стандартный импорт проекта maven.