Skip to content

Latest commit

 

History

History
119 lines (88 loc) · 6.58 KB

CONTRIBUTING.md

File metadata and controls

119 lines (88 loc) · 6.58 KB
Raw

Contributing

Your contribution is greatly appreciated and I hope this document helps you along the way. If you have any questions or problems, don't hesitate to send me an email. ([email protected]).

Pull request process

1. Fork this repository.

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

2. Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone button and choose a way of cloning. If you go with the HTTPS option, it will look like this:

git clone https://github.com/[your username]/interstellar.git

3. Create a branch

First change to the repository directory on your computer (if you're not already there):

cd interstellar

Create a branch using the git checkout command:

git checkout -b <add-your-new-branch-name>

The branch name can be whatever you want, but try to keep it relevant to what you are changing, or adding.

4. Get the project running locally

Make sure you have Node.js (v16+) and Yarn installed before continuing.

Run the following commands in the terminal:

# Install dependencies
$ yarn

# Compiles and hot-reloads for development
$ yarn dev

Follow the given localhost URL in the terminal and you should be up and running.

5. Make necessary changes and commit those changes

Fix what you intended to fix and commit the changes to the branch you created earlier.

6. Push changes to GitHub

Push your changes using the command git push:

git push origin <your-branch>

7. Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button and open a new pull request with your changes.

8. Visit the preview build

After the pull request has been opened, Vercel will automatically deploy a preview build which can be accessed to see how your added changes would look and function in the final build. Take a minute to test it for any bugs.

I18n - Internationalization and localization

We want the tracker to be as easy to use as possible and have therefore added support for different languages, hopefully making it more easy to understand.

All languages are welcome and to contribute a new language just follow these steps:

  1. Follow steps 1-4 above to get the tracker running locally.
  2. Create a new .json file in ./src/i18n/locales/ with the desired locale.
  3. Copy the contents of the en-US.json file in the same directory.
  4. Translate all values to the desired language.
  5. Add your new locale file in ./i18n/locales.js:
import enUs from './locales/en-US.json'
import svSE from './locales/sv-SE.json'
// import [locale] from './locales/[locale].json'

export default {
	'en-US': enUs,
	'sv-SE': svSE,
  // '[locale]': [locale]
}
  1. Follow steps 6-8 above to finalize your contribution.

We use the flag-icons library by lipis for the flags, so make sure that your locale has a supported flag in the library.

Adding a new weapon

Due to the dynamic data based nature of this project, there are several data files that must be edited for any new weapons to display correctly. Missing any of these files can cause parts of the app to break when it cannot find the data.

When adding a weapon please add the camo challenges for both multiplayer and zombies.

  1. Add the new weapon to src/data/weapons/<weaponType>.js. Follow the formatting of the other weapons in this file.
  2. Add the names of the new camos to src/data/camouflages/<camoCategory>.js. Make sure each new camo goes in the correct category. You may need to make a new file if a new weapon introduces a new category.
  3. Add the progression defaults to src/data/defaults/progess/<weaponType>.js. Follow the pattern used by all the other guns.
  4. Add the new camos for the weapon to src/data/requirements/weapons/<weaponType>.js. The unique camos will reference data in another file. Gilded, Forged etc can be defined directly in this file. Follow the pattern used by the other weapons.
  5. Add the requirements for the unique camos in the correct src/data/requirements/camouflages/<camoCategory>.js. The category here is the same as the category used in step 2.
  6. Optional but preferred. Generate images for the camos following the instruction below and upload them to the src/assets/camouflages/ folder ensuring the filenames follow the required format.

Note: the challenge text needed in steps 4 and 5 is provided via i18n. src/i18n/locales/en-US.json already has text for every existing challenge, and there is a high change you can find the text you need already defined in that file.

If the exact wording is not available yet then create a new entry.

Translations of that file into other languages is most welcome!

Camouflage images

If you want to help contribute some images for the camouflages, the process is the same as described above but with a few preferable additions:

  • The images should be in 1x1 format (perfectly squared, or close enough).
  • No borders or background behind the camouflage, just the camouflage itself.
  • The naming of the files should follow the slug-format (Desert Hybrid -> desert-hybrid).
  • The files should preferably be in .png file format.
  • Place the files in the ./src/assets/camouflages folder.

If you don't have access to any image editing software (besides Paint), Photopea is an amazing and completely free Photoshop alternative. I will also happily accept any images, or in-game screenshots, of the camouflages on my email ([email protected]) and I can edit and add them to the site myself!

Note: The camouflage images are hosted on an external server that I need to manually upload the images to, so it might take a while before they are added to the site. This also means that they can't be tested locally.

License

By contributing your code, you agree to license your contribution under the MIT License.