Contributing

Please only share code snippets or scripts that you are happy to be available publicly.

Preparing your script/code

1. Though the website and repository contains license conditions, we suggest you include this snippet as a preface to any source code:

   <one line to give the program's name and a brief idea of what it does.>
       Copyright (C) <year>  <name of author>
   
       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.
   
       This program is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.
   
       You should have received a copy of the GNU General Public License
       along with this program.  If not, see <https://www.gnu.org/licenses/>.

2. [Optional] Format your code using black and isort. This step is optional because these will be automatically run on any pull requests.

3. Fork this repo or clone and create a new branch. If you do the latter, make sure you switch to that branch before making any changes (git checkout <branch_name>)

4. Add your source code to the folder that best matches what it does or pertains to.

   • If you need to create a new folder/page:
     • Create the folder in snippets
     • Create a corresponding .qmd file in the root of the repository. You can use the AEMO data snippets page as an example
     • In the Quarto YAML config, add the .qmd under the snippets menu

5. Commit your changes to your branch/fork, and then open a pull request to merge your changes in

   • This will run pre-commit on all added files

6. Wait for a maintainer to accept the pull request. All done!