Skip to content

Latest commit

 

History

History
110 lines (71 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

110 lines (71 loc) · 3.02 KB
Raw

Getting Started

To get a local copy up and running follow these simple example steps.

Pre-requisites

  • Text Editor | Git and Github set up

How do I submit a Pull Request (PR)?

Contributing follows this workflow:

  1. Fork this project repository.
  2. Clone the forked repository to your computer.
    • git clone https://github.com/<your-github-username>/issue-finder.git
    • cd issue-finder
  3. Create and switch into a new branch.
    • git checkout -b my-branch-name
    • Open the project in your favorite code editor code . for VS Code.
  4. Update or add to the existing code from the issue assigned to you and commit the changes.
  5. Make a PR to merge your fork with this repo.

Usage

To get a local copy running on your browser follow this workflow:

  • Run npm install to load necessary files from package.json
  • Run touch .env

  • Generate your GitHub token here https://github.com/settings/tokens

  • Run echo REACT_APP_API_KEY=ghp_my_github_token > .env
  • Then in your terminal run npm start and view app in your browser

Running code checks

Apply Linter checks with the following instructions

  • Run npm run lint to view errors.
  • Run npm run lint:fix to fix multiple errors.

Contributing to Issue Finder

  • We welcome all meaningful contributions to Issue Finder. If you see any areas of improvement or wish to contribute to existing issues, please connect with our maintainers directly on the issue, and we will be pleased to help you as much as possible.

Contributing - Open Source

1. Fork the repository.

2. Clone your forked copy of the project into your local system.

git clone --depth 1 https://github.com/yourusername/issue-finder.git

3. Navigate to the project directory. 📁

cd healthphilics

4. Add a reference (remote) to the original repository.

git remote add upstream https://github.com/voscarmv/issue-finder.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b pr1

8. Search the "issue-finder" folder, add the modified HTML and CSS files and remove the previous ones.

9. Track your changes. ✔️

git add .

10. Commit your changes.

git commit -m "pulled my first PR"

11. Push the committed changes in your feature branch to your remote repository.

git push -u origin pr1

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15. Voila! You have made a PR to the project. Sit back and relax while your PR is reviewed by the maintainers.