Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (25 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.47 KB
Raw

Contributing Guidelines

We welcome any potential contributions to the gradescopeapi project! Please use this page as a reference if you want to help improve the project by submitting feedback, changes, etc.

Bug Reports/Enhancements Requests

We use GitHub Issues to track any potential bugs along with requests for features to be implemented. Please follow the provided guide for creating your bug report/feature request and we will respond to it as soon as possible.

Making Your Own Changes

If you want to make your own changes to the gradescopeapi, please follow the following instructions:

  1. Clone/Fork the gradescopeapi repository
  2. Create a feature branch
  3. Make your desired changes
  4. Push the changes
  5. Submit a Pull Request

Please ensure that your changes adhere to the coding style. This can be done using pdm to run the ruff linter:

just format
# and
just lint

Pull Requests

If you have existing changes that you want added to gradescopeapi, please create a pull request using GitHub.

Include in your pull request:

  1. Summary of the changes you made
  2. Detailed description of the exact changes
  3. Checks made
  4. A reference to the issue (optional)

Once you have submitted your pull requests, a team member will review the changes and provide feedback as necessary. If your changes are approved, they will be merged with the main branch.