Skip to content

[#2489] Add CITATION.cff for Apache Shiro#2518

Open
iampratap7997-dot wants to merge 3 commits intoapache:mainfrom
iampratap7997-dot:main
Open

[#2489] Add CITATION.cff for Apache Shiro#2518
iampratap7997-dot wants to merge 3 commits intoapache:mainfrom
iampratap7997-dot:main

Conversation

@iampratap7997-dot
Copy link

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • Committers: Make sure a milestone is set on the PR
  • Committers: Use "Squash and Merge" to combine all commits into one when merging a PR when appropriate.

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@iampratap7997-dot
Copy link
Author

Hi,
This is my first contribution to Apache Shiro.
CI appears to be awaiting for maintainer approval to run.
Thank you!

Copy link
Member

@jbampton jbampton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The license check has failed.

Most files do need to have the standard ASF license header.

Otherwise you need to add an exclude in the repo root POM.xml file in the "apache-rat-plugin"

@iampratap7997-dot
Copy link
Author

The license check has failed.

Most files do need to have the standard ASF license header.

Otherwise you need to add an exclude in the repo root POM.xml file in the "apache-rat-plugin"

Hi @jbampton, thank you for reviewing!

Since I do not have permission to edit the pom.xml to exclude CITATION.cff from the RAT license check, I leave it to the maintainers to handle the exclusion.

Thanks!

@lprimak
Copy link
Contributor

lprimak commented Feb 9, 2026

Hi, you absolutely have permission to modify Pom.xml. Please do so.

Co-authored-by: John Bampton <jbampton@users.noreply.github.com>
@iampratap7997-dot
Copy link
Author

Hi, you absolutely have permission to modify Pom.xml. Please do so.

Hi,
Thanks for the clarification.
Will update the pom.xml file asap.
Thanks.

@jbampton
Copy link
Member

jbampton commented Feb 9, 2026

Hi, you absolutely have permission to modify Pom.xml. Please do so.

Hi, Thanks for the clarification. Will update the pom.xml file asap. Thanks.

You have added the license header now that should be enough.

You do not need to update the pom.xml since you added the license header.

You do either one, not both.

@lprimak
Copy link
Contributor

lprimak commented Feb 9, 2026

John, thanks for the clarification!

@iampratap7997-dot
Copy link
Author

Hi, you absolutely have permission to modify Pom.xml. Please do so.

Hi, Thanks for the clarification. Will update the pom.xml file asap. Thanks.

You have added the license header now that should be enough.

You do not need to update the pom.xml since you added the license header.

You do either one, not both.

Thankyou @jbampton for this information.
I'll remember this for the upcoming issues and PR's.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

We can add a CITATION file to the repository to help users correctly cite the Shiro software

3 participants