www.aboutcode.org

This is the repository for the AboutCode public website. It is based on Docusaurus.

Getting started

This requires to have node 20 installed

• npm install

• The staging website is published at: https://aboutcode-org.github.io/www.aboutcode.org/

• The production website is published at: https://aboutcode.org

Contributing

We value contributions from members of the community. You can always suggest a new feature or a change to some existing element of the website by opening an issue and, if you're ready, a PR.

• The normal process for suggesting changes is to create an issue to explain the change before creating a pull request.
  • When you create an issue for the website please prefix the issue title with "WWW" and apply the label "website".
  • The "WWW" prefix in the title is to make it easy to distinguish an issue from "DOC" issues which are about more general documentation and "POST" issues which are ideas for blog posts.
  • The "website" label is to ensure that your issue and activity around it will show up in the AboutCode Slack channel "www-aboutcode-org".
• If you do submit a pull request (PR):
  • DO not use CoPilot or other AI tools to create the PR or its content. AboutCode does not accept AI-generated PRs and dealing with them takes away valuable time from our core work. The use of AI tools for research is fine, but a PR must be created and submitted by a person.
  • Do not include changes to the current project configuration - e.g., do not include an updated package-lock.json or yarn.lock with a PR.
  • Do not add new dependencies with your PR.
• It is OK to submit a PR without an issue to fix typos and other minor corrections. Please explain the changes in the PR.

The staging version of the website is published at: https://aboutcode-org.github.io/www.aboutcode.org/.

The production version of the website (Dreamhost) is published at: https://www.aboutcode.org/.