We will appreciate developers' contribution to improve node.js code generator, to make it even better. Therefore, any contributions related to features, issues, documentation, translation, guides, and more are all welcomed.
You can ask questions, consult with more experienced DhiWise users, and discuss DhiWise-related topics in the our Discord channel.
If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository.
If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
-
For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you craft the change so that it's successfully integrated in the project.
-
Small Features can be added directly submitted as a Pull Request.
If you want to help out with a code contribution, our project uses the following stack:
- Jest (for testing)
Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
Find an issue that you're interested in addressing, or a feature that you'd like to add. You can use this view which helps new contributors find easy gateways into our project.
Fork the repository associated with the issue to your local GitHub organization. This means that you'll have a copy of the repository under your-GitHub-username/repository-name. Clone the repository to your local machine:
git clone https://github.com/DhiWise/nodejs-code-generator
Create a new branch for your fix:
git checkout -b branch-name-here
Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
Once done, stage the changes that are ready to be committed:
git add .
Commit the changes with a short message.
git commit -m "<type>:<package>:<message>"
CLI for better commit messages
npm run commit
Push the changes to the remote repository using:
git push origin branch-name-here
- If you are fixing a bug, start the branch name with bug/bug-name
- If you are adding a feature, start the branch name with feature/feature-name
- Submit you branch to master by creating a PR.
In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.
It's okay if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
Wait for the pull request to be reviewed by a maintainer.
Make changes to the pull request if the reviewing maintainer recommends them.
Celebrate your success after your pull request is merged!
We structure our commit messages like this:
<type>(<package>): <subject>
Example
fix(server): missing entity on init
List of types:
- feat: A new feature
- fix: A bug fix
- docs: Changes to the documentation
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy.