Welcome to Smart-grid! We are glad that you are interested in contributing.
We welcome contributions from everyone. Here are some ways you can contribute:
-
Reporting Bugs: If you encounter a bug, please open an issue and provide as much detail as possible, including steps to reproduce the bug.
-
Requesting Features: If you have a feature request, feel free to open an issue to discuss it. We appreciate detailed descriptions of the requested feature and its use case.
-
Fixing Issues: Raise an issue if you find any issue.
-
Improving Documentation: Documentation is crucial. If you find any errors or areas that need improvement in our documentation, feel free to submit a pull request with your changes.
-
Adding Features: If you want to add a new feature, please open an issue first to discuss it. Once approved, you can work on it and submit a pull request.
To start contributing, follow these steps:
-
Fork the repository to your GitHub account using the Fork button.
-
Clone your forked repository to your local machine:
git clone <your-cloned-repo-url>
- Create a new branch for your changes:
git checkout -b feature/your-feature
- To run the project make sure to download all the packages using npm:
npm install
- Make your changes and commit them with descriptive commit messages:
git add .
git commit -m "Add your commit message"
- Push your changes to your forked repository:
git push origin <your-branch-name>
- Finally, open a pull request on the original repository.
Please follow the existing code style and conventions used in the project. If you are unsure about anything, feel free to ask.
All submissions require review. GitHub pull requests are used for this purpose.
Thank you for your interest in contributing to Smart-grid!