Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 3.01 KB

contributing.md

File metadata and controls

71 lines (48 loc) · 3.01 KB

Contributing

Contributions are very welcome, just open an issue or PR if you see something to improve! See our other communication channels above to coordinate with other contributors!

Please note that all contributions happen under the MIT license as described at the bottom of this page.

Getting involved

If you want to learn more about the general idea go to fedimint.org, beyond a high level explanation you can also find links to talks and blog posts at the bottom of the page.

To get started with development have a look at the:

  • GitHub Issues - things to fix, planned features, longer term architectural choices, etc.
  • Architecture - high-level description of the codebase and design
  • Integration tests - instructions on how to write and run the integration tests
  • Scripts - useful scripts for running the tests and federation

Areas of Contribution

Below are some broad and general areas of contribution to get you started

PRs fixing TODOs or issues are always welcome, but please discuss more involved changes in an issue first. Smaller PRs to fix typos, broken links etc. are also very welcome.

For commits, please use imperative mood.

Happy hacking!

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.