# How to Contribute <div align="center"> <a href="https://github.com/pdfosborne/elsciRL"></a> <a href="https://github.com/pdfosborne/elsciRL-Wiki"></a> <a href="https://discord.gg/GgaqcrYCxt"></a> </div> **Quicklinks:** [Homepage](https://elsci.org) | [About Us](https://elsci.org/About+us) | [FAQs](https://elsci.org/FAQs) | [New Developers](https://elsci.org/Developer+Guide) | [App Interface Guide](https://elsci.org/App+Interface+Guide) | [Using the Wiki](https://elsci.org/Docs+&+Wiki+Guide) **Open-source Contributors are essential to the success of elsciRL.** You can provide improvements to the software, add your own models or applications or even provide knowledge to the Wiki. In return you gain experience with open-source software and will be recognized in the community as a notable supporter with a unique Discord role. ## Getting Started with the Software If you are ready to begin applying the elsciRL Python library: [Getting Started](https://elsci.org/Developer+Guide) ## Benchmarking Suite elsciRL can be used as a benchmarking suite for systematically evaluating new methods. To get started, see [Benchmarking with elsciRL](<./elsciRL Core/V - Benchmarking Suite/1 - Benchmarking with elsciRL.md>). ## Custom Development You can develop your own agents, analysis and experiment protocols to compare against known methods. To get started with a custom development setup, see [New Developer Guide](https://elsci.org/Developer+Guide). ## Use the Open-Source Documentation for Personal Use The elsciRL Wiki is written using [Obsidian.md](https://obsidian.md/) and backed-up through GitHub as an open-source documentation site. If you wish to download the documentation for personal use: ^58a83d 1. Download the [elsciRL-Wiki](https://github.com/pdfosborne/elsciRL-Wiki) (click the *Code* button > *Download ZIP*) 2. Unzip the Vault to a local directory (e.g. inside Documents) 3. [Download Obsidian.md](https://obsidian.md/download) 4. Open the Obsidian software 5. Select the *Open folder as Vault* option and then the *elsciRL-Wiki* folder *You can open the vault in any software that can read markdown files but it is suggested you use Obsidian.md as we use some features and plugins to improve the experience.* *The links on the main pages such as 'Homepage' or 'New Developers redirect to the website to improve usability. Any pages inside the folders are connected locally and will link locally within obsidian.* ### Obsidian Configuration By default, not all formatting will work without the correct plugins but they can be setup by: 1. Overriding the configuration folder in *Obsidian>Files and Links settings* to this folder *.obsidian-git* (see image below) 2. Lastly, restart obsidian  ## Contributing to the Documentation If you wish to contribute to the project: 1. Fork the vault repository. 2. Clone the vault repository a local directory 3. Edit the documentation locally with the core changes you wish to implement 4. Commit your changes to a new branch. 5. Push the new branch to your forked repository 6. Open a new *Pull Request* at the vault repository for committing your changes. <div id="sticky-button"> <a href="https://discord.gg/GgaqcrYCxt"><img src="https://raw.githubusercontent.com/pdfosborne/elsciRL-Wiki/refs/heads/main/Resources/images/discord_icon.png" width="50"></a> </div>