More detailed "Development Guide" Recommendations

[birm]

Add comments here to change or extend the caMicroscope development guide section of the README.

[AbdulRashidReshamwala]

Add how to setup for development

  viewer:
    build: "../caMicroscope"
    container_name: ca-front
    volumes:
      - ./config/login.html:/var/www/html/login.html
      - ../caMicroscope/:/var/www/html/  

[AbdulRashidReshamwala]

I think we should setup a linter such as eslint to maintain a standard formatting in all file

[birm]

That was an adventure; done with #272

[cjchirag7]

We can include this :

How to Contribute

When you are ready to start work on a issue:

• Let us know by leaving a comment on the issue. (Also let us know later if you are no longer working on it.)
• Once you are assigned the issue (or once you have claimed the issue) only then proceed to making the Pull Request. This will help avoid multiple PRs pertaining to the same issue.

If you don't see your idea listed, do one of the following:

• If your contribution is minor, such as a typo fix, open a pull request.
• If your contribution is major, such as a new feature/enhancement, start by opening an issue first. That way, other people can be also involved in the discussion before you do any work.

Pull Request Process

1. Create a branch. For example, if you are going to work on issue number Add microscope icon and remove home icon from the caMic Lymphocyte toolbar #44 (which is, say, a new feature for ‘forgot password’ management):

    git checkout -b forgot-password#44
   

   This both creates and checks out that branch in one command.
   The feature name should provide a (short) description of the issue.

2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

3. Develop the feature, check the build, make sure that there are no linting errors by running ESLint commands, as listed in 'travis.yml'

4. Push it to your local repo.

5. Create Pull Request (PR). Make sure to comment the issue that your PR is supposed to solve, so that the issue can be closed automatically when the PR is merged.

Reference : https://github.com/CircuitVerse/CircuitVerse/blob/master/CONTRIBUTING.md (liked this a lot)

[cjchirag7]

We can also set up a script in package.json, so that the user can check for linting errors on all the files, at once. I would like to work on this.

[cjchirag7]

I have setup the 'lint' script in #282 . Please review it

[sohamsshah]

We can add the following to the development guide(or can extend it to a wiki page or similar):

• We can split the contributor guide for:
  • Developers
  • Others(users, testers, designers etc.)
    And can have a general contributor guide and specific to each of the Devs and Others.

For Developers we already have CONTRIBUTING.md file, but can add more details to help contributors to get started with the project easily.

Currently the CONTRIBUTING.md has:

• What types of code contributions are accepted
• Pull Request Guide
• Report Bugs via issue(can also include in Non-developers guide too as end-users report valuable bugs many times)
• Coding Style
• License
• References

We can add:

• How to set up development environment on(Windows, Linux etc. OS if separate details are needed)
• They should be accompanied with relevant commands or code snippets
• Can add linting rules here
• Testing and coverage improvement brief
• Screenshots to support the development env setup guide
• Can elaborate the issue creation and PR procedure
• A bit of information of the Tech Stack that is used to develop the project
• Also can add the resources to learn them (docs reference, video reference)

(Also, if there is some major changes in techstack happening(like shifting to a different framework), that can be listed here itself in this seperate guide; along with beginner-friendly issues as well as the others. This can possibly attract many more members to community as the collaborator or mentor can assign issues to the contributors as well.)

Thank you. Would love to know the opinions and views upon this and work on this issue.

[siddhanth339]

Can anyone provide detailed instructions on how to set up this application locally on Windows 10

[birm]

@siddhanth339, what issues are you experiencing when trying the instructions?

[siddhanth339]

Now it's working fine with the help of this article camicroscope-development-environment. We could add a detailed setup file to this repository for people having trouble running it locally i.e., right from including steps about installing docker with wsl2 to using the application locally (how to access each path, set jwt token, etc).

[birm]

We can look at pull request if you have a suggestion. 😃

[siddhanth339]

I will work on it and create a pull request soon.

[Priyaraj17]

Actually, something related to setting up the development environment is going to be very useful for everyone, it will help a lot of people, even I encountered problems related to the set up.

[birm]

Closing as a stale issue. Feel free to reopen if you think this should be active still.