Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 6.74 KB

CONTRIBUTING.md

File metadata and controls

82 lines (65 loc) · 6.74 KB

Fluid Project Contribution Guidelines

Fluid is an open, collaborative project to improve the user experience and inclusiveness of open source software. The Fluid community consists of an international team of partners, individuals, and institutions focused on designing inclusive, flexible, customizable, user-centered interfaces.

The Fluid Project website is built using 11ty

To run the project locally

  1. Clone the project locally using git clone https://github.com/fluid-project/fluidproject.org.git
  2. Go to the directory where you cloned the project in terminal using cd fluidproject.org
  3. Get the required Node.js modules using npm install
  4. Run eleventy from the fluid-website directory npm run start
  5. Open http://localhost:8080/ in a browser to see the website.

Contributions to the project can be made in following ways-

Contribution towards building features for the project

  • Go to Issues page in order to report some bug or suggest an improvement/enhancement or a new feature.
  • Use the Issues template and Pull Request template provided in the .github folder for reporting new issues or submitting new Pull Request.

Submitting new news articles

  • Go to the src/YYYY-MM-DD-newsarticletemplate.md file

  • Create a new Markdown file with title in the following format

    • YYYY-MM-DD-{News Article Name with underscores in place for spaces}.md.

  • Use the YYYY-MM-DD-newsarticlename.md file as template.

  • Update the date, title and permalink in the front matter.

  • Your article must use the following template for 11ty to process it properly: --- layout: layouts/post title: Title of News Article date: 'YYYY-MM-DD' filename: Short URL for news. May contain Capital Items but no spaces --- Content Data

  • The URL for news articles is generated from the date and title metadata.

  • If filename metadata is present, then output filename will be created using the date and filename (instead of the default date and title filename). Use this option if the article title is too long for a good filename, or for supporting legacy posts with unusual naming.

  • The use of filename metadata in front matter is optional and should be used only if automatic filename of {date}-{title} is not sufficient.

Reporting Issues or Bugs in the repository

  • Go to https://github.com/fluid-project/fluidproject.org/issues/new/choose
  • Choose the appropriate Issue template from "Bug Report" and "Feature Request"
  • Add Title and Description as per given in the template.
  • Click on 'Submit New Issue'.

The directory structure is as follows

File or Folder Description
.github Directory containing the Issue templates as well as GitHub Actions workflow configuration files
src Contains all the files needed to build the site using 11ty. This includes the content for all pages and news articles, CSS files, layout and partial templates, and JavaScript files.
.eleventy.js The Configuration file used by 11ty in order to build the site. Specifies the collections for 11ty, passthrough copy files, and other settings including the source folder for input and output.
.eleventyignore A list of files and folders which are ignored by Eleventy while building the site
.gitignore A list of files and folders which won't be tracked by Git.
.eslintrc.json ESLint configuration data.
.eslintignore A list of files and folders which won't be passed through ESLint
AUTHORS.md List of copyright holders and contributors
Gruntfile.js Grunt file used to copy data from node_modules and do linting process.
package.json Contains scripts and a list of dependencies required to build the site, as well as general information about the repository
README.md Read Me file provides introduction to the repository.

Pull Requests

After a Pull Request (PR) has been submitted, one or more members of the community will review the contribution. This typically results in a back and forth conversation and modifications to the PR. Merging into the project repo is a manual process and requires at least one Maintainer to sign off on the PR and merge it into the project repo. You may wish to ping a Maintainer on the #fluid-work IRC channel, fluid-work mailing list, and/or on the PR itself.

If you have any questions or comments regarding this repository, feel free to visit Get Involved page of our wiki to connect with us.