diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9add49f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to `fseval` +Awesome that you are looking to contribute to `fseval`! Be it just a small spelling-correction, a bugfix, or a bigger and more structural change; all contributions are welcome. Let's make the process as easy and transparent for you as possible. + +Please see the [developer guide](https://dunnkers.com/fseval/docs/contributing/) on the website. + +## Pull Requests +We welcome your pull requests. + +1. Fork the repo and create your feature branch from `master`. +2. If you've added code add suitable tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite and lint pass. + +## Issues +We use GitHub issues to track public bugs. Please ensure your description is +clear and has sufficient instructions to be able to reproduce the issue. + +## License +By contributing to hydra, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree. \ No newline at end of file diff --git a/website/docs/contributing.md b/website/docs/contributing.md new file mode 100644 index 0000000..98e623c --- /dev/null +++ b/website/docs/contributing.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 7 +--- + +# Developer Guide +Hi Developer! Great that you want to contribute to `fseval`. Let's get you started as soon as possible. + +## Cloning `fseval` +First, clone the repository to your local computer. Do the following: + +``` +git clone https://github.com/dunnkers/fseval.git +``` + +> Make sure you have [Git](https://git-scm.com/) installed. + +This creates a folder called `fseval`. Open it in your prefered editor. + +## Installing the required packages + +### Option A: using a Devcontainer +If you happen to use VSCode as your editor, you can open `fseval` in a [**Devcontainer**](https://code.visualstudio.com/docs/remote/containers). Devcontainers allow you to develop _inside_ a Docker container - which means all dependencies and packages are automatically set up for you. First, make sure you have the [Remote Development extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) installed. + + +Then, you can do two things. + +1. Click the following button: + + [![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dunnkers/fseval) + +1. Or, open up the repo in VSCode. Then, you should see the following notification: + +![reopen in devcontainer](/img/contributing/reopen-in-devcontainer.png) + +Now you should have a fully working dev environment working 🙌🏻. You can run tests, debug code, etcetera. All dependencies are automatically installed for you. + +Run/debug tests: + +![tests view vscode](/img/contributing/tests-view-vscode.png) + +🙌🏻 + +### Option B: installing the dependencies manually +Make sure you are in the `fseval` folder (cloned in the previous step), and run: + +``` +pip install -r requirements.txt +pip install -r .devcontainer/requirements.txt +pip install . +``` + +Now, you should be able to run tests: + +``` +pytest tests +``` +![pytest started](/img/contributing/pytest-started.png) + +## Developing the website +The documentation website is built with [Docusaurus](https://docusaurus.io/). To start the server, do the following: + +``` +cd website +yarn +yarn start +``` + +Which should start the documentation website: + +![docs website started](/img/contributing/docs-website-started.png) + +🙌🏻. + +You can now edit everything in `docs` and the website should be live updated at [http://localhost:3000/fseval/](http://localhost:3000/fseval/). Create a Pull Request once you are done making edits. Cheers! \ No newline at end of file diff --git a/website/static/img/contributing/docs-website-started.png b/website/static/img/contributing/docs-website-started.png new file mode 100644 index 0000000..feb09ff Binary files /dev/null and b/website/static/img/contributing/docs-website-started.png differ diff --git a/website/static/img/contributing/pytest-started.png b/website/static/img/contributing/pytest-started.png new file mode 100644 index 0000000..0d3932f Binary files /dev/null and b/website/static/img/contributing/pytest-started.png differ diff --git a/website/static/img/contributing/reopen-in-devcontainer.png b/website/static/img/contributing/reopen-in-devcontainer.png new file mode 100644 index 0000000..cdf72b8 Binary files /dev/null and b/website/static/img/contributing/reopen-in-devcontainer.png differ diff --git a/website/static/img/contributing/tests-view-vscode.png b/website/static/img/contributing/tests-view-vscode.png new file mode 100644 index 0000000..5e31b66 Binary files /dev/null and b/website/static/img/contributing/tests-view-vscode.png differ