Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.78 KB

contributing.md

File metadata and controls

23 lines (14 loc) · 1.78 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or email with the owners of this repository before making a change.

How to Contribute to BeamNGpy

Before Starting

  • if you are fixing a bug, make sure that it still exists on the dev branch
  • open up an issue to discuss the changes you want to make
  • make sure you agree to our contributor license agreement

Accepting the Contributor License Agreement

If you are a submitting work on behalf of yourself, then read through this form and send a mail to [email protected] agreeing to the contributor license agreement. The mail should contain your full name, your GitHub username, your address, your phone number, email and explicitly state that you agree to the "BeamNGpy Individual Contributor License Agreement".

If you are a submitting work on behalf of your employer, then read through this form and send a mail to [email protected] agreeing to the contributor license agreement. The mail should contain your full name, the name of your organization, your GitHub username, your address, your phone number, email and explicitly state that you agree to the "BeamNGpy Entity Contributor License Agreement".

Submitting Your Contribution

  1. Create a fork of the repository.
  2. Using dev as a base branch create your own branch with a meaningful name and modify/add existing code following the PEP 8 style guide. Add tests where appropriate.
  3. Push your branch to your fork and create a pull request from your branch to the dev branch. Posting the pull request will trigger a git action requesting you to accept the contribution license agreement.