2023-12-09 19:03:58 +00:00
|
|
|
# Getting Started {#sec-contrib-getting-started}
|
|
|
|
|
|
2024-04-27 12:44:37 +00:00
|
|
|
You, naturally, would like to start by forking the repository to get started. If
|
|
|
|
|
you are new to Git and GitHub, do have a look at GitHub's [Fork a repo guide](https://help.github.com/articles/fork-a-repo/)
|
|
|
|
|
for instructions on how you can do this. Once you have a fork of **nvf**, you
|
|
|
|
|
should create a separate branch based on the msot recent `main` branch. Give
|
|
|
|
|
your branch a reasonably descriptive name (e.g. `feature/debugger` or
|
|
|
|
|
`fix/pesky-bug`) and you are ready to work on your changes
|
2023-12-09 19:03:58 +00:00
|
|
|
|
2024-04-27 12:44:37 +00:00
|
|
|
Implement your changes and commit them to the newly created branch and when you
|
|
|
|
|
are happy with the result, and positive that it fullfills our [Contributing
|
|
|
|
|
Guidelines](#sec-guidelines), push the branch to GitHub and [create a pull
|
|
|
|
|
request](https://help.github.com/articles/creating-a-pull-request). The default
|
|
|
|
|
pull request template available on the **nvf** repository will guide you through
|
|
|
|
|
the rest of the process, and we'll gently nudge you in the correct direction if
|
|
|
|
|
there are any mistakes.
|
