Skip to content

Commit

Permalink
Add a skeleton structure
Browse files Browse the repository at this point in the history
  • Loading branch information
tecosaur committed Feb 16, 2024
1 parent 4249dee commit 2371f41
Show file tree
Hide file tree
Showing 8 changed files with 76 additions and 2 deletions.
6 changes: 6 additions & 0 deletions make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ makedocs(;
clean = true,
pages = [
"Julia Developer's Guide" => "index.md",
"Issues" => "issues.md",
"Documentation" => "documentation.md",
"Proposing changes" => "proposals.md",
"Code" => "code.md",
"Walkthrough" => "walkthrough.md",
"Core Developers" => "developers.md",
],
sitename = "Julia Developer's Guide",
authors = "The Julia Project",
Expand Down
17 changes: 17 additions & 0 deletions src/code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Basic checklist

# Kinds of code contributions

### Core functionality or base libraries

### The standard library

### Patch releases

# Tests

# Formatting guidelines

# [Reviewing code](@id reviewing)

# Tips
7 changes: 7 additions & 0 deletions src/developers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Core developers

# Accepting pull requests

# Areas of expertise

# Becoming a core developer
1 change: 1 addition & 0 deletions src/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

34 changes: 32 additions & 2 deletions src/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,37 @@
# Julia Developer's Guide
# Introduction

The Julia project thrives on the efforts of it's community to help improve the
project. We'd love to help you get involved too! This guide is a comprehensive
resource for new and experienced contributors alike. There are many more ways to
contribute than just submitting code, all highly valuable and greatly
appreciated.
appreciated 😍.

# Types of contributions

- [Filing an issue](issues.md)
- [Contributing code](code.md)
- [Reviewing submitted pull requests](code.md#reviewing)
- [Proposing changes](proposals.md)
- [Improving the documentation](documentation.md)

# Asking questions

The [discourse forum](https://discourse.julialang.org/) and [zulip
chat](https://julialang.zulipchat.com/register/) are great places to ask
questions. On discourse we have the [new to
Julia](https://discourse.julialang.org/c/first-steps/8) and [General
Usage](https://discourse.julialang.org/c/usage/6) categories, and Zulip has
[#helpdesk](https://julialang.zulipchat.com/#narrow/stream/225542-helpdesk). We
also have a [Julia Slack](https://julialang.org/slack/) and an (unofficial)
[Discord server](https://discord.gg/mm2kYjB).

**Please ask questions!** Don't worry about "wasting expert time", contributors
are important to us. If you feel comfortable, it's good to ask questions in
public spaces so others can see the questions and answers, and learn from them
too.

# Code of conduct

We want to maintain a friendly and welcoming environment, all interactions in
official Julia spaces should respect the [community
standards](https://julialang.org/community/standards).
7 changes: 7 additions & 0 deletions src/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Filing issues

# Triaging issues

# GitHub labels

# Triage team
4 changes: 4 additions & 0 deletions src/proposals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Small changes

# Large changes

2 changes: 2 additions & 0 deletions src/walkthrough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Walkthrough of a typical contribution

0 comments on commit 2371f41

Please sign in to comment.