Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 3.09 KB

contribution.md

File metadata and controls

54 lines (38 loc) · 3.09 KB

NeutralinoJs Contribution Guide

Hello there, we are glad to know you found your way here. Your interest in this project gives us joy, and it will be a welcoming gesture and a great help if you make a contribution.

Understanding NeutralinoJs

This is to give you a subtle knowledge of what NeutralinoJs is and what it is not.

  • NeutralinoJs is a desktop/cloud application development framework.
  • NeutralinoJs apps run in browser, rather than standalone desktop apps.
  • You will need knowledge of Web technologies to build NeutralinoJs apps.
  • The project is fairly new for now, lacking contributors for a fast paced development.

Contribution Repositories

  • neutralinojs - This is the main repository for NeutralinoJs, it contains source code for building Neutralino SDK, you can provide your contributions here if you are interested in coding.
  • neutralinojs.github.io - This repository contains source for NeutralinoJs Docs and project Website. Please consider looking into it, if you are interested in writing documentation.
  • neutralinojs-samples - Have you built an Neuttralino app? Would you like to share its source for others to learn? You can also contribute to NeutralinoJs by sharing your NeutralinoJs apps on this repository.


View all NeutralinoJs Repositories: Click here

How to contribute?

  1. Choose a NeutralinoJS Repository you want to contribute to.
  2. View an area on the repository, you feel like that has a problem.It can range from a typo to something bigger and more sensitive.
  3. Fork the repository.
  4. Make file changes, commit with an appropriate message on the forked repository.
  5. Create a pull request.

Contribute with Care

We appreciate you interest, and your enthusiasm is what may help this project to build further, but here are certain things we would like you to take care of while contributing.

  1. Contribute in chunks, a lot of changes may break the master branch, and there might be certain changes we would not want to make. In this case, it is advisable to contribute by making changes to few related files at once.

  2. Please have a look at the ReadMe of the repository you want to contribute to. Sometimes, the information that is only meant for particular repository is provided in its ReadMe, so have a look at it before you start making your contribution.

  3. Please be consistent wih the style being followed already while making any changes, we will add the style guide later, but for now please consider having look on the previously added files.

  4. Consider talking to a contributor or in any NeutralinoJs community, if you want to propose any changes on the current state of the project.

  5. Last but not the least, Good Luck with your contributions.

Some Helpful Links

Slack Community Channel

NeutralinoJs Repositiories

NeutralinoJs Website