Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #122

Merged
merged 1 commit into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
© 2024 Vlad-Stefan Harbuz <[email protected]>
SPDX-License-Identifier: CC-BY-SA-4.0
-->

# 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).
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 0 additions & 13 deletions TECHNICAL.md

This file was deleted.

Loading