Skip to content

Commit

Permalink
docs: new contribution guidelines (#4163)
Browse files Browse the repository at this point in the history
Provides a new set of contribution guidelines to help existing and new
contributors understand the process and help them in getting code merged
into the code base more quickly.

The focus of this rewrite is:
* to introduce some recommendations for a post-mainnet Tari
* Outline the release process post-mainnet
* Outline the PR review and evaluation process post-mainnet (but
  starting to implement immediately)
* to provide guidelines that result in contributions that are easy to
  review, allowing reviewers to catch more bugs.

## Important 

This PR is a starting point for a discussion around these guidelines. This is not me coming down from the mountain with a set of clay tablets. I've done a fair bit of research and thinking, and also consulted with many other devs, including @fluffypony in reaching this draft. However I expect that the final version, when it is merged, will be somewhat different from what is written here now, but my hope is that the spirit of it remains.
  • Loading branch information
CjS77 authored Aug 5, 2022
1 parent 622763a commit a4b1115
Show file tree
Hide file tree
Showing 10 changed files with 554 additions and 16 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/pr_title.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
# Checks that PR titles conform to Conventional Commits
# See https://www.conventionalcommits.org/en/v1.0.0/ for more information
name: PR

on:
Expand Down
488 changes: 472 additions & 16 deletions Contributing.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions RFC/src/theme/images/status-active.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions RFC/src/theme/images/status-wip.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-deprecated.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-draft.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-outofdate.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-raw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-retired.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions meta/img/status-stable.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4b1115

Please sign in to comment.