|
| 1 | +# Welcome to Simply-DJS contributing guide |
| 2 | + |
| 3 | +Thank you for spending your time in this dumb package which makes things simple. |
| 4 | + |
| 5 | +Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep this awesome community approachable and respectable. |
| 6 | + |
| 7 | +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. |
| 8 | + |
| 9 | +Use the table of contents icon <img src="https://user-images.githubusercontent.com/71836991/161290822-002e81c2-265c-46d6-be19-2d2bafbc00e5.png" width="30" height="30" /> on the top left corner of this document to get to a specific section of this guide quickly. |
| 10 | + |
| 11 | +## New contributor guide |
| 12 | + |
| 13 | +To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: |
| 14 | + |
| 15 | +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) |
| 16 | +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) |
| 17 | +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) |
| 18 | +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
| 19 | + |
| 20 | +`(Source: Github Docs)` |
| 21 | + |
| 22 | +### Issues |
| 23 | + |
| 24 | +#### Create a new issue |
| 25 | + |
| 26 | +If you spot a problem with the package, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/Rahuletto/simply-djs/issues/new/choose). |
| 27 | + |
| 28 | +#### Solve an issue |
| 29 | + |
| 30 | +Search through our [existing issues](https://github.com/Rahuletto/simply-djs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. |
| 31 | + |
| 32 | +### Make Changes |
| 33 | + |
| 34 | +#### Make changes to the function |
| 35 | + |
| 36 | +Click **Make a contribution** at the README.md file to make small/big changes such as a typings, Grammatical Mistake, etc.. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. |
| 37 | + |
| 38 | +#### Make changes locally |
| 39 | + |
| 40 | +1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage). |
| 41 | + |
| 42 | +2. Fork the repository. |
| 43 | +- Using GitHub Desktop: |
| 44 | + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. |
| 45 | + - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! |
| 46 | + |
| 47 | +- Using the command line: |
| 48 | + - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. |
| 49 | + |
| 50 | +3. Install or update to **Node.js v16**. For more information, see [the development guide](contributing/development.md). |
| 51 | + |
| 52 | +4. Create a working branch and start with your changes! |
| 53 | + |
| 54 | +### Commit your update |
| 55 | + |
| 56 | +Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages. |
| 57 | + |
| 58 | +Once your changes are ready, don't forget to self-review :zap:. |
| 59 | + |
| 60 | +### Pull Request |
| 61 | + |
| 62 | +When you're finished with the changes, create a pull request, also known as a PR. |
| 63 | +- Fill the "PULL_REQUEST" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. |
| 64 | +- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. |
| 65 | +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. |
| 66 | +Once you submit your PR, Our members will review your proposal. We may ask questions or request for additional information. |
| 67 | +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. |
| 68 | +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). |
| 69 | +- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. |
| 70 | + |
| 71 | +### Your PR is merged! |
| 72 | + |
| 73 | +Congratulations :tada::tada: Simply-DJS Team thanks you :sparkles:. |
| 74 | + |
| 75 | +Once your PR is merged, your contributions will be reflected to the [NPM Package](https://npmjs.org/simply-djs) |
| 76 | + |
| 77 | +Now that you are part of the our community, you can join our support server to have a talk :love: |
0 commit comments