Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING guidelines #67

Open
05nelsonm opened this issue Dec 9, 2024 · 0 comments
Open

Add CONTRIBUTING guidelines #67

05nelsonm opened this issue Dec 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@05nelsonm
Copy link
Member

05nelsonm commented Dec 9, 2024

Need a CONTRIBUTING.md which outlines things for contributors.

  1. Contributions must follow current code conventions and formatting of the code base.
    • Class names / Algorithm names
    • Proper encapsulation (basically nothing exposed but a constructor depending on implementation)
    • Documentation
  2. Contributions must conform to the Digest abstraction.
  3. Contributions must implement the :tools:testing module for commonTest and jvmTest.
@05nelsonm 05nelsonm added the documentation Improvements or additions to documentation label Dec 9, 2024
@05nelsonm 05nelsonm changed the title Add Contributor guidelines Add CONTRIBUTING guidelines Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant