Thank you for considering contributing to the everythingToEverywhere repository! We are excited to see that you want to participate in improving this project.
The project build is done using the command npm run build. To test the package locally, you can perform a local installation using the command npm i <local_path>.
-
Fork the Project: Start by forking the project to your GitHub account.
-
Clone the Project: Clone the project from your account to your local machine.
git clone https://github.com/your-username/everythingToEverywhere.git- Create a Branch: Create a branch to work on your new feature or fix.
git switch -c my-branch-name-
Make Changes: Make the necessary changes and ensure your code follows to the project's conventions. Use Conventional Commits for naming and splitting commits.
-
Test Locally: Test your code locally to ensure it works correctly.
-
Submit a Pull Request: Once you are satisfied with your changes, submit a pull request to the main branch of the project.
All tasks and discussions are managed via issues on GitHub. Check the issues page to see what collaborators are currently working on.
If you would like to work on a specific task, please assign yourself to that issue or discuss it in the comments.
Join the discussions on the project by checking the various sections of the Projects board. We also have internal discussion groups if you wish.
Please read and follow our Code of Conduct. We encourage a respectful and inclusive environment.