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(CONTRIBUTING): update contributing guidelines based on Tokio #9

Merged
merged 2 commits into from
Nov 23, 2022

Conversation

SanchithHegde
Copy link
Member

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation

Description

Updates CONTRIBUTING.md based on Tokio's contributing guidelines

Additional Changes

  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

I felt that the current contributing guidelines could have been improved.

How did you test it?

This change does not warrant testing.

Checklist

  • I formatted the code cargo +nightly fmt
  • I addressed lints thrown by cargo clippy
  • I reviewed submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

The following pieces of information are yet to be added:

  • Information about tests
  • Versioning policy, if any
  • Release process
  • Links to Slack/Discord

I'll create a separate issue for the same.

@SanchithHegde SanchithHegde added C-doc Category: Documentation updates S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Nov 23, 2022
@SanchithHegde SanchithHegde self-assigned this Nov 23, 2022
Copy link
Contributor

@ashokkjag ashokkjag left a comment

Choose a reason for hiding this comment

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

Looks good. Just make sure that the text isn't duplicated somewhere else, especially things like commit message guidelines.

@SanchithHegde
Copy link
Member Author

Just make sure that the text isn't duplicated somewhere else, especially things like commit message guidelines.

As of now, commit message guidelines are only up on Confluence, so the only public place containing the guidelines is this repository.

@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Nov 23, 2022
@jarnura jarnura merged commit a083f70 into main Nov 23, 2022
@jarnura jarnura deleted the contributing-guidelines branch November 23, 2022 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc Category: Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants