3rdparty/flameddogo99-eaglermobile
1
0
Fork 0
mirror of https://github.com/FlamedDogo99/EaglerMobile.git synced 2024-09-19 15:36:00 -07:00
Code Issues Packages Projects Releases Wiki Activity
04699b19aa
flameddogo99-eaglermobile/.github/CONTRIBUTING.md
FlamedDogo eef626f9d2
Update CONTRIBUTING.md 
Changed branch name in link
2024-06-15 13:50:24 -06:00

4.0 KiB
Raw Blame History

Contributing guidelines

Whether you want to send us feedback, fix a problem, or something else, you are welcome to contribute! Our code is open source.

Be sure to follow our code of conduct.

Reporting bugs and suggesting features

Found a bug? Have an idea? You can open an issue to report bugs and send feedback! But first, be sure to search for existing issues. If there are no similar issues, you can create a new one. You can also open a discussion to suggest ideas or ask questions. We will take a look at it.

Contributing code

If you are familiar with JavaScript, HTML, and CSS, you can contribute by fixing bugs or adding features. Just follow the steps below to propose your changes which we can then add to Eagler Mobile.

Getting set up to contribute

We recommend using Git to commit changes. If you prefer GUIs, you can also set up GitHub Desktop. If you don't want to install anything, you can use the GitHub website, but we strongly recommend one of the other options to speed up the process.

In order to fork the repository and open a pull request, you'll need a GitHub account.

New to contributing? octocat/Spoon-Knife and this guide are good resources to learn the process.

Looking for a code editor? We recommend Visual Studio Code.

Opening a pull request

  1. If you have something in mind, it's best if you create or find an issue first (see above). That way, we can discuss it before you start a pull request.
  2. Fork this repository if you haven't already.
  3. Clone your fork and load it in your browser so you can make and test your changes.
  4. Create a new branch, specifying upstream/main as the source branch: 
    git checkout -b BRANCH-NAME upstream/main
    Branching makes things easier later on if you have multiple pull requests open at once or ever want to contribute again. You can always delete a branch.
  5. Make and test your changes.
  6. Commit and push your changes to the branch.
  7. Go to the website to create a pull request in the source repository (FlamedDogo99/EaglerMobile). There should be a banner with a button to open a pull request. Screenshot of the banner above the list of files. (If you don't see it, you can manually open a pull request by navigating to the "Pull requests" tab, clicking "New pull request", then clicking "Compare across forks" and selecting your fork and branch next to "head repository". Then click "Create pull request" to go to the next step.)
  8. Finally, fill out the form. Remember to check "allow edits from maintainers" in case we need to make adjustments. Once you're done, click "Create pull request"!

Once your pull request is open, we will review and discuss the changes and any necessary adjustments.