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

Create CONTRIBUTING.md guidelines #1303

Closed
alice-i-cecile opened this issue Jan 24, 2021 · 3 comments
Closed

Create CONTRIBUTING.md guidelines #1303

alice-i-cecile opened this issue Jan 24, 2021 · 3 comments
Labels
C-Docs An addition or correction to our documentation

Comments

@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jan 24, 2021

What problem does this solve or what need does it fill?

We should have one central place to point new (and old) contributors when they have questions about the contribution process, especially when it come to PRs.

I think this is particularly valuable for contributors who are new to Rust or open source development. This is more likely to be true with Bevy than other projects, due to its accessibility and broad interest.

What solution would you like?

Create a CONTRIBUTING.md file.

Current steps for making a PR:

  1. Fork the repo.
  2. Make changes locally.
  3. Run cargo fmt. Run cargo +nightly fmt.
  4. Run cargo clippy. Take the clippy command from the workflows folder & run the same command.
  5. Submit a pull request with a descriptive title and any important context about the changes.

What alternative(s) have you considered?

Continue to pass this information on one contributor at a time, or trust that they're experienced to know how to do so.

Additional context

Prompt for this issue.

@rparrett
Copy link
Contributor

Should that be cargo +nightly fmt?

@CleanCut
Copy link
Member

Like this? #1309

@Moxinilian Moxinilian added the C-Docs An addition or correction to our documentation label Jan 25, 2021
@CleanCut
Copy link
Member

Actually resolved by bevyengine/bevy-website#85 -- the place to point to is https://bevyengine.org/learn/book/contributing/code/

#1309 continues down a different avenue...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation
Projects
None yet
Development

No branches or pull requests

4 participants