Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.

Latest commit

 

History

History
31 lines (16 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 2.5 KB

Contributing

All contributions are welcome to the project, the curators try to review all PRs as quickly as possible. Yet, this is a volunteer run project, so please be patient with it. If you are planning on submitting bigger changes to the projects, please open a github issue first and talk to the team before submitting to make sure your work will be accepted. Please refer to the CONTRIBUTING document for details.

The curators might reject any contribution without stating a reason, but especially if the contribution or contributor in question is not following the code of conduct or doesn't follow the right procedure outlined below.

Submitting a package

If a package isn't listed on the website yet, feel free to send us a pull-request for it. The only requirement we have on packages is that they are related to numerical algorithms, open source and publicly available via crates.io. Please make sure the pull request contains the following:

  • the data for your package (see the [DOCS] on how to do that)
  • adds the package to the appropriate topic(s)

If you are in a hurry and don't have the time to prepare the PR, you can also submit an issue requesting for the package to be added. Make sure you mark the issue with the please-add-tag.

And add a few words to the PR (or issue) about the package and why it should be listed (e.g. novel approach, popularity, first of its kind...). The more info we have (and the less work it is), the more likely it will be added soon.

Submitting Project News

You have an important announcement or latest news related to numerical algorithm development in rust and you'd like to share them with the wider audience of this website? GREAT, here is how you can do that:

We are using the normal jekyll blog engine features to provide news. Just create a new file in _posts - we recommend to use Markdown. Make sure you set the layout to news and added all appropriate tags. Once you are done, please submit all of that as a pull-request and we get right on it!

Complaining about incorrect text

Please open a github issue if you feel that anything is represented or out of date. Keep in mind that the description of a package is directly pulled from crates.io and won't be changed here (other than just pulling it again, later).

Becoming a curator

You want to help curate the listing? Awesome. Just open a issue on github, giving some info about you and why you want to join.