Contributing to MFT-NLP
Ways to contribute
- Propose papers and datasets to add to the site
- Record details from papers (models used, performance results, etc.)
- Propose new features for the site
- Add written content to the site
- Identify issues with the site
- Fix issues with the site
Site details
- Development for the site is managed via GitHub.
- If you are not familiar with git and GitHub, don’t worry :)
- Many contributions can be made by creating a GitHub Issue, which is as easy as a post on a forum-style website. Learn more here
- If you’re not comfortable with that and still want to contribute, email the maintainers at info@mft-nlp.com for help.
- To add content to the site data, or the site itself, you can create a pull request if you are familiar with GitHub
- The site is built using Jekyll, a static site generator.
- Jekyll supports a mix of markdown and html content.
- Pages for tasks, datasets, foundations, methods, and papers are auto-generated from the site data JSON files.
- The site data is stored in the data folder.
Contributing to the site data (task, datasets, papers, methods, foundations)
- Fork the repository. Learn more here.
- Clone your forked repository to your local machine.
- Edit the JSON files in the mft-nlp/data/ folder in your local copy.
- Commit your changes to your local copy.
- Push your changes to your forked repository.
- Create a pull request to merge your changes into the main repository. Learn more here.
Contributing to other site content
- Fork the repository. Learn more here.
- Clone your forked repository to your local machine.
- Edit the markdown or html files in the mft-nlp/ folder in your local copy.
- I use Visual Studio Code to edit the markdown files, but you can use whatever you are comfortable with.
- Preview the changes locally by running the site locally. Learn more here.
- Commit your changes to your local copy.
- Push your changes to your forked repository.
- Create a pull request to merge your changes into the main repository. Learn more here.
