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

Add info to CONTRIBUTING about how to setup the repo #1296

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ChaelCodes
Copy link
Contributor

@ChaelCodes ChaelCodes commented Jun 13, 2024

Add a really short and basic description of how to setup the development environment. Even though it's very brief, I think it's helpful for newer OSS contributors and over-thinkers to have a dev setup guide in the contributing guide.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • [-] Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • [-] Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
  • [-] If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@ChaelCodes
Copy link
Contributor Author

Happy to update this with any feedback or suggestions about how this section could be changed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant