mirror of
https://github.com/FlamedDogo99/EaglerMobile.git
synced 2024-11-23 20:46:04 -08:00
45 lines
4.0 KiB
Markdown
45 lines
4.0 KiB
Markdown
# 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](https://github.com/FlamedDogo99/EaglerMobile/blob/main/.github/CODE_OF_CONDUCT.md).
|
|
|
|
## Reporting bugs and suggesting features
|
|
|
|
Found a bug? Have an idea? You can [open an issue](https://github.com/FlamedDogo99/EaglerMobile/issues/new/choose) to report bugs and send feedback! But first, be sure to [search for existing issues](https://github.com/FlamedDogo99/EaglerMobile/issues). If there are no similar issues, you can create a new one. You can also open a [discussion](https://github.com/FlamedDogo99/EaglerMobile/discussions) 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](https://docs.github.com/en/get-started/quickstart/set-up-git) to commit changes. If you prefer GUIs, you can also [set up GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-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](https://github.com/octocat/Spoon-Knife) and [this guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) are good resources to learn the process.
|
|
|
|
Looking for a code editor? We recommend [Visual Studio Code](https://code.visualstudio.com/).
|
|
|
|
### 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](https://docs.github.com/en/get-started/quickstart/fork-a-repo) if you haven't already.
|
|
3. [Clone your fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) and load it in your browser so you can make and test your changes.
|
|
4. [Create a new branch](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#creating-a-branch-to-work-on), specifying `upstream/main` as the source branch:
|
|
```shell
|
|
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](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-and-pushing-changes) 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.
|
|
|
|
(If you don't see it, you can [manually open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) 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.
|
|
|