Skip to main content

How to Contribute

Fork the repository​

Go to https://github.com/Hackathons-UK/wiki and press fork in the top right - This will create a copy of the repository in your own GitHub Account

Make your changes​

NOTE: Please only change one area per PR, we will reject overly large PRs.

  1. Clone your forked repository, to your local machine using the new repository URL: git clone [email protected]:<USERNAME>-UK/wiki.git
  2. Create a new branch for your changes: git checkout -b <BRANCH-NAME> - Try to keep it relevant to the change you wish to make.
  3. Make the desired, changes to your local repository,
  4. Test and verify any changes
  5. Commit your changes with a clear commit message which explains what you have done git commit -m "updated topic X with Y"
  6. Push your changes to your forked repository git push

Make a PR against upstream​

  1. Go to your repository on GitHub
  2. Navigate to the Pull Requests tab
  3. Press the green New Pull Request
  4. Set base repository to Hackathons-UK/wiki - Main
  5. Set head repository, to <USERNAME>/wiki - <BRANCH-NAME>
  6. Review your changes to make sure it looks correct
  7. Provide a detailed title and description of your changes, to the pull request - this will help the maintainers know the intent behind the request.
  8. Submit Pull Request

Wait for review​

Once submitted the maintainers will review your PR after some time, they will either accept and merge it or they may add some comments asking for clarification or some changes to be made.