This documentation contains a set of guidelines to help new users and potential contributors to MDF.
Welcome to ModECI/MDF! Before opening pull requests, make sure that you read these guidelines. If you have any doubt on this contributing guide, please feel free to reach out on our discussion forum.
-
Install the MDF package and all its dependencies: https://github.com/ModECI/MDF (see below).
-
Try running locally the standard MDF examples: https://github.com/ModECI/MDF/tree/main/examples/MDF
-
Run the following notebook, altering the network elements along the way to build your own model: https://github.com/ModECI/MDF/blob/main/examples/SimpleExample.ipynb.
-
Read the documentation on the elements of the MDF specification: https://mdf.readthedocs.io/en/latest/
-
The project uses an issue tracker to keep information about bugs to fix, project features to implement, documentation to write, and more. Potential contributors can look for newcomer-friendly issues by looking for the following issue tags in the project issue tracker: good first issue
Following are the steps to guide you:
-
Step 1: Fork the repo and Go to your Git terminal and clone it on your machine.
-
Step 2: Add a upstream link to main branch in your cloned repo
git remote add upstream https://github.com/ModECI/MDF.git -
Step 3: Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
git pull upstream main https://github.com/ModECI/MDF.git -
Step 4: Create your feature branch (This is a necessary step in order to avoid any disorder in main branch (e.g. bugfix/22))
git checkout -b <feature-name> -
Step 5: Commit all the changes
git commit -m "Write a meaningful but small commit message" -
Step 6: Push the changes for review
git push origin <branch-name> -
Step 7: Create a PR on Github.
- Don't just hit the create a pull request button, you should write a PR message to clarify why and what are you contributing.
- Put the hashtag of issue in a commit message for the pull request, and it will show up in the issue itself which will make easy for developers to review your PR based on issue.
- Step 1: Fork the repo and Go to your Git terminal and clone it on your machine (If done already go directly to next step)
git clone https://github.com/ModECI/MDF - Step 2 : Go to local path of repo
cd MDF - Step 3 : Install
pip install .
- Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
- Git : Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.
You can refer to the following articles on basics of Git and Github, in case you are stuck: