Thank you for considering contributing to React Scroll Magic! I appreciate your time and effort to help improve the project. Here are some guidelines to help you get started.
- Fork the repository: Click the "Fork" button at the top right of the repository page.
- Clone your fork:
git clone https://github.com/your-username/react-scroll-magic.git- Create a branch:
- please use the github issues to generate a branch for you, you can then use it to checkout locally manually or use github desktop
- Install dependencies:
npm install- Make your changes: Ensure your code follows the project's coding standards.
- Run tests:
npm test- Commit your changes:
Write a meaningful commit message: Ensure your commit message clearly describes the changes you have made. This helps maintain a clear project history and makes it easier for others to understand the purpose of your changes.
git commit -m "Add feature X to improve Y"- Push to your fork:
git push origin your-branch-name- Create a pull request: Go to the original repository and click "New pull request".
- Describe your changes: Provide a clear and concise description of what you have done.
- Link to issues: If your pull request addresses any issues, link to them in the description.
Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
Thank you for contributing!