SustainOSS.org Website

Getting started

The easiest way to contribute to this project is via GitPod. GitPod will set up your developer environment in the browser with your GitHub credentials.

Alternatively, you can run the application locally:

• Install Ruby (preferably version 2.7.x) make sure you select "Add Ruby to PATH"
• Run bundle install
• Run bundle exec jekyll s to build and watch for changes (http://localhost:8000/)

npm tasks

• Install Node.js, preferably version 16 LTS
• Run npm i
• Run npm run autoprefixer to update the vendor prefixes in our Sass files; should be run frequently
• Run npm run svgo:base -- assets/img/foo.svg to optimize specific file(s) or npm run svgo
• Run npm run to see the available npm scripts

Contribute

Please contribute! Open an issue, make a pull request, reach out for help. This organization is entirely volunteer run, and your contributions are important.

We use Slack to discuss our changes and to talk about community issues, as well as GitHub. Join our community slack here. Join the channel #sustain to talk to us.

If you need help with using GitHub in order to open an issue, sign up for an account, come back to this page, and open an issue by clicking here. Ping one of us on Slack if you need help.

License

MIT © 2018 Justin Dorfman and Contributors.

If you contribute to this repository, you are agreeing to the License terms and agreeing that an MIT license is appropriate for your contributions.