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

Help new contributers by adding CONTRIBUTING.md. #32

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

justindhillon
Copy link

CONTRIBUTING.md tells new contributors how to make pull requests. Here is what it looks like:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

@alexfilothodoros
Copy link
Contributor

Nice idea! Maybe it would be useful to add sth like " Run ruff check . before pushing.

@justindhillon
Copy link
Author

Nice idea! Maybe it would be useful to add sth like " Run ruff check . before pushing.

Sounds great! The CONTRIBUTING.md file now looks like this:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Test your changes (ruff check .)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

@anoopshrma
Copy link
Contributor

Great addition @justindhillon !

Copy link
Contributor

@jerryjliu jerryjliu left a comment

Choose a reason for hiding this comment

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

amazing thanks!

@jerryjliu
Copy link
Contributor

@justindhillon i think there's a lint error, could you run make format; make lint?

@justindhillon
Copy link
Author

@justindhillon i think there's a lint error, could you run make format; make lint?

Thanks @jerryjliu ! I ran the commands and now all tests pass. I also added the formating your code step to the Contributing.md file. It now looks like this:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Test your changes (ruff check .)
  4. Format your code (make format; make lint)
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Ready to merge.

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.

None yet

4 participants