diff --git a/make.jl b/make.jl index d646a79..c64c6b1 100755 --- a/make.jl +++ b/make.jl @@ -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", diff --git a/src/code.md b/src/code.md new file mode 100644 index 0000000..b484888 --- /dev/null +++ b/src/code.md @@ -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 diff --git a/src/developers.md b/src/developers.md new file mode 100644 index 0000000..1da8415 --- /dev/null +++ b/src/developers.md @@ -0,0 +1,7 @@ +# Core developers + +# Accepting pull requests + +# Areas of expertise + +# Becoming a core developer diff --git a/src/documentation.md b/src/documentation.md new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/documentation.md @@ -0,0 +1 @@ + diff --git a/src/index.md b/src/index.md index bbe975c..234e702 100644 --- a/src/index.md +++ b/src/index.md @@ -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). diff --git a/src/issues.md b/src/issues.md new file mode 100644 index 0000000..f63e1db --- /dev/null +++ b/src/issues.md @@ -0,0 +1,7 @@ +# Filing issues + +# Triaging issues + +# GitHub labels + +# Triage team diff --git a/src/proposals.md b/src/proposals.md new file mode 100644 index 0000000..8872772 --- /dev/null +++ b/src/proposals.md @@ -0,0 +1,4 @@ +# Small changes + +# Large changes + diff --git a/src/walkthrough.md b/src/walkthrough.md new file mode 100644 index 0000000..3fb9346 --- /dev/null +++ b/src/walkthrough.md @@ -0,0 +1,2 @@ +# Walkthrough of a typical contribution +