Skip to content

Latest commit

 

History

History
63 lines (35 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

63 lines (35 loc) · 1.86 KB
Raw

Contributing

Comments and pull requests to this project are welcome.

General repository structure

All mission files in the directory missions are generated automatically via scripting tasks in the Rakefile. Therefore if you would like to contribute, make sure you apply your changes to the files in the src directory. Don't forget to regenerate the mission files once you are done!

Build tasks

This project uses the ruby build utility called rake.

All build tasks are contained in the Rakefile of this project.

How to contribute a pull request

  1. Fork the lua_missions repository first, then clone it:

    git clone [email protected]:your-username/lua_missions.git

  2. Apply your changes to the files in the src directory.

  3. Make sure you can execute all missions without errors or failures:

    rake missions:run_src

  4. Regenerate the mission files:

    rake missions:gen

  5. Commit your changes to your repository. You may use the corresponding rake task for that. If you added new files, don't forget to git add them prior to your commit.

    rake git:commit -m='your commit message'

  6. Push to your fork. Again, you may use the corresponding rake task for that.

    rake git:push

  7. Submit a pull request.

At this point you have to wait for me. I try to at least comment on pull requests within a few days. Be prepared that I may suggest some improvements and/or propose changes or alternatives.

Mission solving

With the rake infrastructure in place, you may start solving the missions right away:

rake missions:run

Since missions:run is the default rake task, you may start mission solving by simply typing:

rake