Contributing to BLS12-381 Library for Aiken

May 28, 2024 ยท View on GitHub

Thank you for considering contributing to the BLS12-381 library for the Aiken Cardano smart-contract language! Your contributions help make this library better for everyone. Here are some guidelines to help you get started.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the problem efficiently.

Contributing Code

  1. Fork the Repository: Click on the 'Fork' button on the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine using:

    git clone https://github.com/ilap/bls.git

  3. Create a Branch: Create a new branch for your work:

    git checkout -b feature-or-bugfix-description

  4. Make Changes: Implement your changes in this branch.

  5. Commit Changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "Description of the changes"

  6. Push to Your Fork: Push your changes to your forked repository:

    git push origin feature-or-bugfix-description

  7. Open a Pull Request: Navigate to the original repository and open a pull request from your forked branch. Provide a detailed description of your changes.

Code Style

Please follow the existing code style in the project. Ensure your code is clean, readable, and well-documented.

Testing

Make sure your changes are well-tested. Add new tests for your changes where appropriate, and ensure all existing tests pass. Run the tests using:

aiken check

Documentation

If your contribution changes any library functionality or adds new features, please update the documentation accordingly. This includes the README.md file and any other relevant documentation files.

Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Please review our Code of Conduct before contributing.

Thank you for your interest in contributing to the library! We're excited to see what you build with it.