Skip to content

First Contribution

b5635 edited this page Nov 21, 2024 · 9 revisions

If you're not interested in contributing, making a PR, etc. you can skip this section.

This picks up from Getting Started and Building the Module. If you haven't read or followed the instructions in those pages, please do so before continuing.

Also, please have a goal in mind when contributing. It can be something like adding placeables and decoration to the city core, revamping the roads of Neverwinter, your very own quest, etc. You can also get an idea of what to work on by taking a look at the issues.

For starters, you can take a look at the issues and see if there's any you want to hammer out. I highly suggest looking at Story page as well to get an overview of what will be implemented story and campaign wise.

Also, please know that I am very, very open to ideas and in fact a lot of the issues and stories added have been suggested and even implemented by players. So don't be shy and put in an issue - I'll be happy to discuss how it can be developed!

Updating your Repository

Because the repository you have is a fork, it is not automatically updated or synced with the latest one. Always make sure it is updated before starting a branch. Here's the command to merge the upstream: Branch > Merge into Current Branch, or by pressing Control + Shift + M (Command + Shift + M on a Mac)

Select upstream/master, and merge.

Run nasher_install.bat to synchronize your module files. Do not do this if you have some uncommitted changes or you may lose them.

Making a Branch

We can group up our changes by making a branch in GitHub Desktop. Do this by going to Branch > New Branch or by pressing Control + Shift + N (Command + Shift + N on a Mac).

Let's say our goal is adding enemy bugbears to Neverwinter Wood.

Unpacking and adding a Commit

Okay, so we've modified the area to have some bugbear encounters. Run nasher_unpack_folder.bat to extract the files into src so git can recognize the changes.

After doing that, you should see some changes in GitHub Desktop. Let's add a summary, an optional description, and then "Commit".

Finally, we will publish this branch to your forked repository.

Adding a Pull Request

Go to this page, then click "compare across forks".

Next, select the "head repository" field and select your forked repository (has your GitHub name in it)

Select the "compare" field, and pick the branch you were working on.