From 6670ade741209e74b58313a002ff472e2bc7f80f Mon Sep 17 00:00:00 2001 From: Vlad-Stefan Harbuz Date: Thu, 19 Sep 2024 10:59:27 +0100 Subject: [PATCH] Add CONTRIBUTING.md Just a tiny bit of documentation to prevent future confusion. --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++-- TECHNICAL.md | 13 ------------- 3 files changed, 42 insertions(+), 15 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 TECHNICAL.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ffcd128 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ + + +# Contributing + +This document contains various bits of information that might be useful for contributors. + +## Running Locally + +To run locally: + +``` +npx astro dev +``` + +Make sure you run TypeScript checks after making TypeScript changes: + +``` +npx astro check +``` + +## New Member Workflows + +When a new member joins, workflows are run to update `src/content/members`. The workflow can be found in +`.github/workflows/deploy.yml`, and the code that updates member data can be found in `bin/`. + +## Copyright Headers + +We maintain copyright headers at the top of every file to establish authorship. Once you make substantive changes to any +file, add yourself to the copyright headers. + +Remember that copyright statements such as “(C) John Smith 2020” contain the year copyright _started_, i.e. 2020 is the +year the work was first created, not the current year. + +## Browser Support + +The least-supported clientside feature we're using is CSS Nesting. This means that our supported browser are described +by the [CSS Nesting Can I Use page](https://caniuse.com/css-nesting). diff --git a/README.md b/README.md index ba42b0d..4abd3e1 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ Open Source Pledge is brought to you by [Sentry][sentry] and [contributors][cont * **Want to make the Pledge?** Find out [how to join][join]. * **Want to participate as a maintainer, foundation or funding platform?** Join an upcoming [ecosystem partners call][ecosystem-call] to learn more and be heard. -* **Want to help?** [Dive into our issues][issues] or reach out to the working group leads listed below either in issues - or [on Discord][discord]. +* **Want to help?** Read [CONTRIBUTING.md](CONTRIBUTING.md), [dive into our issues][issues], and feel free to reach out + to the working group leads either in issues or [on Discord][discord]. [contributors]: (https://github.com/opensourcepledge/osspledge.com/graphs/contributors). [discord]: https://discord.gg/svH5XzDsBd diff --git a/TECHNICAL.md b/TECHNICAL.md deleted file mode 100644 index 406bc16..0000000 --- a/TECHNICAL.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# Technical Information - -This document contains various bits of technical information for contributors. - -## Browser Support - -The least-supported clientside feature we're using is CSS Nesting. This means that our supported browser are described -by the [CSS Nesting Can I Use page](https://caniuse.com/css-nesting).