We welcome contributions to the SharpAPI Node.js SDK Client! If you'd like to contribute, please follow these steps:
-
Fork the Repository
Click the "Fork" button at the top-right corner of the repository page to create your own fork.
-
Clone the Forked Repository
git clone https://github.com/yourusername/sharpapi-node-client.git
-
Navigate to the Project Directory
cd sharpapi-node-client
-
Create a New Branch
git checkout -b feature/your-feature-name
-
Make Your Changes
Implement your feature or bug fix.
-
Commit Your Changes
git add . git commit -m "Add feature: Your Feature Name"
-
Push to Your Fork
git push origin feature/your-feature-name
-
Create a Pull Request
Go to the original repository on GitHub and create a pull request from your forked repository.
- Follow Coding Standards: Ensure your code adheres to the existing coding style.
- Write Tests: Add tests for your new features or bug fixes.
- Update Documentation: If your changes affect the usage, update the
DOCUMENTATION.md
accordingly. - Provide Clear Descriptions: Make sure your commit messages and pull request descriptions are clear and concise.