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

docs: Add CONTRIBUTING.md #531

Merged
merged 3 commits into from
Jun 23, 2022
Merged

Conversation

orpheuslummis
Copy link
Contributor

@orpheuslummis orpheuslummis commented Jun 15, 2022

Relevant issue(s)

Resolves #29

Description

The goal of the CONTRIBUTING.md is to be guidance to new and existing contributors to the repository.

I excluded or haven't a few things as they aren't ready or can be in a different document:

  • Signing release
  • Debugging recommendations
  • Cross-compiling
  • stuff about digital signatures
  • stuff about using graphql clients
  • relating to public versus internal
  • Performance analysis
  • nightly runs
  • security-related policies
  • community guidelines

Starting as a draft PR. You're very welcome to give feedback and general commentary.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Reviews from human contributors.

@orpheuslummis orpheuslummis added the documentation Improvements or additions to documentation label Jun 15, 2022
@orpheuslummis orpheuslummis added this to the DefraDB v0.3 milestone Jun 15, 2022
@orpheuslummis orpheuslummis self-assigned this Jun 15, 2022
@orpheuslummis orpheuslummis added the action/no-benchmark Skips the action that runs the benchmark. label Jun 15, 2022
@orpheuslummis
Copy link
Contributor Author

orpheuslummis commented Jun 15, 2022

This comment/post maintains a link to preview the latest version of the markdown file for your convenience.

https://github.com/sourcenetwork/defradb/blob/d0c2722679391b7aba63e1087854bb33e78f8636/CONTRIBUTING.md

@orpheuslummis
Copy link
Contributor Author

orpheuslummis commented Jun 15, 2022

@sourcenetwork sourcenetwork deleted a comment from source-devs Jun 15, 2022
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@jsimnz jsimnz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love it! LGTM

@orpheuslummis
Copy link
Contributor Author

love it! LGTM

Thanks. I suggest for this PR to wait for few days more for the core team's feedback and Pavneet's feedback, then getting it merged.

Copy link
Member

@shahzadlone shahzadlone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems in harmony with the discussions we had =). Giving an approval even though it's draft right now haha.

Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for actioning my suggestions. 👍

@orpheuslummis orpheuslummis marked this pull request as ready for review June 22, 2022 02:03
@orpheuslummis
Copy link
Contributor Author

Pavneet will contribute feedback later!

@orpheuslummis orpheuslummis merged commit 5312801 into develop Jun 23, 2022
@orpheuslummis orpheuslummis deleted the orpheus/docs/contributing-doc branch June 23, 2022 17:14
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action/no-benchmark Skips the action that runs the benchmark. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CONTRIBUTORS/CONTRIBUTIONS doc
4 participants