Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

91 lines (59 loc) · 5.33 KB
Raw

Contributing to uqcsbot

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to uqcsbot. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the UQCS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Got a Question or Problem?

If you would like to chat about the question in real-time, you can reach out via our slack and ask for help on any of the following appropriate channels:

  • #bot-testing - bot-related questions (i.e. APIs)
  • #python - language specific questions
  • #projects - general implementation questions

How Can I Contribute?

Reporting Bugs

Bug reports are tracked as GitHub issues. When you are creating a bug report, please include as many details as possible about what the problem is and how to reproduce it. This helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎. If an issue already exists for the bug, add any additional helpful details as a comment on that issue. Even better, you can submit a Pull Request with a fix!

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement issue, please provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most users.

Your First Code Contribution

Unsure where to begin contributing to uqcsbot? You can start by looking through these entry level and help-wanted issues:

  • Entry level issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than entry level issues.

Local development

See the README for getting started on local development.

Pull Requests

  1. Fork the UQComputingSociety/uqcsbot repo.

  2. Clone the repo locally:

    git clone https://github.com/your-username-here/uqcsbot.git

  3. Make your changes in a new git branch:

    git checkout -b my-fix-branch

  4. Create your patch, including test cases where appropriate.

  5. If creating a script that can be called by a user, ensure you write an appropriate helper docstring. Examples can be found in any of the existing scripts, and additional usage syntax can be found here.

  6. All Python code must adhere to the PEP-8 Styleguide as closely as possible. Line lengths are usually not an issue, but do try and keep them under 80/100 characters where possible.

  7. Run the full test suite, as described in the README, and ensure that all tests pass.

  8. Commit your changes using a descriptive commit message.

    git add .
git commit -m "descriptive message"

  9. Push your branch to GitHub:

    git push origin my-fix-branch

  10. In GitHub, send a pull request to uqcsbot:python-rewrite.

    • If we suggest changes then:
    • Make the required updates.
    • Re-run the test suite to ensure tests are still passing.

  11. If the PR is a small addition, one approval should suffice before merging. Else for more complicated PRs, multiple approvals may be necessary.

That's it! Thank you for your contribution!

Additional Notes

This doc was adapted from the Atom and Angular Contributing documents.