-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1108 from ParamBirje/contributing-docs
Added CONTRIBUTING.md for a detailed contribution guide.
- Loading branch information
Showing
1 changed file
with
83 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
|
||
## Contributing | ||
|
||
Contributions are welcome and always appreciated! | ||
|
||
Do keep in mind before you start working on an issue / posting a PR: | ||
- Search existing PRs related to that issue which might close them | ||
- Confirm if other contributors are working on the same issue | ||
|
||
## Run Locally | ||
Ensure you have the following dependencies installed: | ||
- Install `node` and `yarn` | ||
- Configure your IDE to support ESLint and Prettier extensions. | ||
|
||
After having above installed, proceed through the following steps to setup the codebase locally. | ||
|
||
- Fork the project & [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it locally. | ||
|
||
![fork-project](https://github.com/responsively-org/responsively-app/assets/87022870/2cae8b2a-850c-4f80-8ede-32eba622a854) | ||
|
||
- Create a new separate branch. | ||
|
||
```bash | ||
git checkout -b BRANCH_NAME | ||
``` | ||
- Go to the desktop-app directory. | ||
|
||
```bash | ||
cd desktop-app | ||
``` | ||
|
||
- Run the following command to install dependencies inside the desktop-app directory. | ||
|
||
```bash | ||
yarn | ||
``` | ||
|
||
- This will start the app for local development with live reloading. | ||
|
||
```bash | ||
yarn dev | ||
``` | ||
|
||
## Running Tests | ||
|
||
It is crucial to test your code before submitting a pull request. Please ensure that you can make a complete production build before you submit your code for merging. | ||
|
||
- Build the project | ||
```bash | ||
yarn build | ||
``` | ||
|
||
- Now test your code using the following command | ||
```bash | ||
yarn test | ||
``` | ||
|
||
Make sure the tests have successfully passed. | ||
|
||
## Pull Request | ||
|
||
🎉 Now that you're ready to submit your code for merging, there are some points to keep in mind. | ||
|
||
- Fill your PR description template accordingly. | ||
- Have an appropriate title and description. | ||
- Include relevant screenshots/gifs. | ||
|
||
- If your PR fixes some issue, be sure to add this line with the issue **in the body** of the Pull Request description. | ||
```text | ||
Fixes #00000 | ||
``` | ||
|
||
- If your PR is referencing an issue | ||
```text | ||
Refs #00000 | ||
``` | ||
|
||
- Ensure that "Allow edits from maintainers" option is checked. | ||
|
||
## Community | ||
Need help on a solution from fellow contributors or want to discuss about a feature/issue? | ||
|
||
Join our [Discord](https://responsively.app/join-discord)! |