search

sailpoint-oss / rule-development-kit

A development environment setup for creating rules.
MIT License
7 stars 25 forks source link

[FEATURE] How to contribute to the repository? #4

Open drosenbauer opened 1 year ago

drosenbauer commented 1 year ago

Please create (or we can create together) some sort of contribution guide for this repository.

Questions to answer so far:

tyler-mairose-sp commented 1 year ago

Hey @drosenbauer,

I can create a first pass, and would definitely like to work together on it.

Q: What parts of the repository are considered "internal" and shouldn't be touched?

The repository is open source so any improvements that can be made, should be made. The only thing I wouldn't modify is the rule-java-docs jar. With that being said, your other issue https://github.com/sailpoint-oss/rule-development-kit/issues/3 about putting that jar in maven central would alleviate any non-modifiable code.

Q: If code is added by a contributor, what Java packages to use? (I was thinking sailpoint.rdk.whatever)

There is a helper class that pulls the source out of the XML code to evaluate the rule. I just refactored to the package sailpoint.rdk.utils. That is a good package name to use for any extensions to the tool.