Skip to content

Latest commit

 

History

History
136 lines (88 loc) · 6.62 KB

CONTRIBUTING.md

File metadata and controls

136 lines (88 loc) · 6.62 KB
Raw

Contributing

What & How Can You Contribute?

  1. Feedback

    Contributions in the form of feedback and issues are very much welcome. Whether it may be a suggestion, a bug report, or maybe some questions that you have. It helps in improving Aiken in over time and these are the best kind of contributions to start with.

    Do not hesitate to add thumbs up 👍 on open issues you support to show your interest.

  2. Documentation

    Any updates, typo fixes, or expansion of the documentation is more than welcome. At the moment, we are using nextra to run https://github.com/aiken-lang/site. That can be considered user level documentation but that is not strict. There is also doc comments in the Rust code, which can be considered strictly developer level documentation.

  3. Code

    Getting started

    • git clone git@github.com:aiken-lang/aiken.git
    • cd aiken
    • cargo test
    • cargo run -- help

    Note if you have nix installed, you can run nix develop to take advantage of the projects dev-shell flake. This will provide any needed tools and dependencies in a reproducible way.

    If everything runs fine without any errors you're good to go. If you do run into any errors please come chat with us on Discord (#aiken)

    Coding standards are enforced using CI. Make sure to configure your editor to pick them up. As an example, if you're using VSCode, please use the rust-analyzer extension. Then turn on format on save and map check to clippy in the VSCode settings. Any clippy or formatting errors will cause CI to fail.

    Pull requests are welcome, but we do recommend you open an issue to bring any idea to discussion first! Especially if the pull request will end up very large, any significant changes should be discussed up front with the maintainers. This avoids awkward situations where someone puts in a bunch of work to ultimately have the pull request closed due to a potential variety of unforeseen reasons.

    CI runs the following commands. To save time, it's good to run these on your local machine before pushing to origin.

    cargo build --workspace
cargo test --workspace
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings

    Changelog

    Please add an entry into CHANGELOG.md when submitting changes. New entries should go into the [next] YYYY-MM-DD section. This let's us keep track of unreleased changes for use in release notes.

    Once a release is ready [next] YYYY-MM-DD gets replaced with a version number and a the release date [0.0.0] 2009-01-03. Usually the maintainers will handle the section renaming along with creating a new empty [next] YYYY-MM-DD section at the top of the changelog.

    Each release section will be further broken down into three sections named Added, Changed, and Removed. Please put the associated crate's name in bold followed by a : as a prefix to the new entry.

    ## [next] - YYYY-MM-DD

### Added

- **crate**: some new thing

### Changed

- **crate**: fixed or updated something

### Removed

- **crate**: something is gone now

  4. Donation

    Want to give some financial support? Have a look at the ways to sponsor below for more details.

    Want to support with crypto?

    • Our Ada address is addr1q83nlzwu4zjeu927m8t24xa68upgmwgt5w29ww5ka695hc5rez2r4q7gcvj7z0ma6d88w3j220szsqk05sn43ghcsn4szvuklq
    • Our Ada handle is $aiken_lang

Releasing

To be able to create a release you need to be on the maintainers team. This means that only core team members can create releases. We have a github action for creating the binaries and a github release. The process follows these steps:

  1. cargo release --execute
  2. After a release is created by the github action fill in the release notes. Try to tag contributors so that they show up in the release.
  3. Screenshot the result of aikup and post on twitter saying "We've just released vx.x.x". example

cargo release takes arguments and flags to tell it how to bump the version number. Examples include cargo release 1.0.16-alpha and cargo release major.

The root Cargo.toml in the repo contains this configuration for cargo release:

[workspace.metadata.release]
shared-version = true
tag-name = "v{{version}}"

Important

Since v1.1.4, we have switched to producing statically linked binary with musl, preventing issues with openssl on various linux platforms. However, this changes the artifact name from: aiken-x86_64-unknown-linux-gnu.tar.gz to aiken-x86_64-unknown-linux-musl.tar.gz. Consequently, we've patched aikup in version v0.0.11, but people using previous version will fail to install aiken through aikup. So for a little a while, we need to manually re-upload a -gnu.tar.gz archive (which can be obtained by simply renaming the musl one) so that aikup can keep fetching artifacts on Linux prior to version v0.0.11. We can cease doing that once enough time has reasonably passed and enough people have switched to aikup.

Ideally, we should introduce an upgrade command to aikup, and have some kind of notification system that indicates to people that they should upgrade their aikup installer.

About Issues

🐛 How To Report A Bug

Open a Bug Issue.

💡 How To Propose An Idea

Feel free to bring any idea as a discussion [category: idea]. Make sure to highlight your use case so we can understand the design space and agree on a solution.

Note Ideally, follow this simple template:

  • What is your idea? Describe it in simple words. Provide a use case.
  • Why is it a good idea?
  • What is the current alternative and why is it not good enough?

❓ How To Ask a Question

Open a Q&A Discussion.

Make sure to mark your question as Answered once resolved!

Need Help Getting Started?

Should you be unsure about where to start, feel free to come and chat on Discord (#aiken).