Skip to content

contributing.md

Latest commit

 

History

History
93 lines (61 loc) · 2.75 KB

contributing.md

File metadata and controls

93 lines (61 loc) · 2.75 KB

🤝 Contributing

Thank YOU for even considering contributing 💖

Adding content (events/resources/etc)

Content can be added in two different ways:

  1. Via the admin site: https://techwerkers.nl/admin
  2. Running decap-server locally (see heading below) and commiting the changes instead.

[!INFO] The admin site will only be accessible to those that have access to the netlify admin. You can ask for access in our slack channel.

Content Guidelines

General writing guidelines:

  • Use plain language wherever you can. We want as many people to be able to understand the content as possible.
  • Expand acronyms on first use. For example, "Tech Workers Coalition (TWC)"
  • Use inclusive language

Internationalization - We want to have our site in at least Dutch and English. If you are unable to provide one or the other, please write in the language you can, and ask for translation help in the #local-netherlands Tech Workers Coalition Slack channel.

Running decap-server

Run both of the following

hugo server
npx decap-server

Then open https://localhost:1313/admin in your browser to see the Decap CMS. Any new content or changes will be saved to disk, so you can commit and make a PR as per normal.

Developing the site

Pre-requisites

You will need to have Hugo installed first.

Also, we use prettier for formatting.

npm i  # Install, if you haven't already
npx prettier --write .

We have a workflow that will check for prettier things, so please make sure you run before submitting a PR.

[Re-]Initializing the site

[!INFO] This only needs to be done if you need to generate a go.mod. If it already exists you can ignore this.

hugo mod init github.com/techworkersco/twc-site-nl

And for good measure, to remove unused entries:

hugo mod tidy

Developing or running the site

This is a Hugo site, so it will be similar to editing any other Hugo theme. In general:

  1. Check out the repo
  2. Run hugo server to start the development server
  3. Open https://localhost:1313 in your browser
  4. Make the changes you need (hugo has live refresh things)
  5. Commit your changes, and make a PR.
    • Be sure to add your motivations for the changes in the PR description.
  6. Get approval, maintainers will merge when they're happy with the changes.
  7. Celebrate 🎉

Regenerating styles (tailwind)

If you are changing styles and not seeing the expected results, then you may need to run tailwind.

  1. npm i
  2. npm run build

This will regenerate the styles from assets/css/main.css into assets/css/compiled/main.css which is used by the site when rendering.

Note: npm run dev can be used if you want a watcher for tailwind. (e.g. frequent changes)