Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

62 lines (36 loc) · 2.88 KB
Raw

Contributing to Meteor

Thank you for considering contributing to Meteor! We welcome contributions from the community to help make this project better. Whether you're a developer, designer, writer, or just an enthusiastic user, there are many ways you can contribute.

Before you start contributing, please take a moment to review this document for guidelines on how to contribute effectively to Meteor.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy of it in your GitHub account.

  2. Clone Your Fork: Clone the repository to your local machine using the following command, replacing [your-username] with your GitHub username:

git clone https://github.com/pixelib/Meteor.git
  1. Create a Branch: Create a new branch for your contributions, where [branch-name] is a descriptive name for your branch:
git checkout -b [branch-name]

  1. Make Changes: Make your desired changes to the codebase. Ensure that your code follows the project's coding guidelines.

  2. Test Your Changes: If applicable, test your changes thoroughly to ensure they work as expected. Add or update any necessary tests.

  3. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

git commit -m "Your descriptive commit message here"
  1. Push Your Changes: Push your changes to your forked repository on GitHub:
git push origin [branch-name]

  1. Create a Pull Request (PR): Go to the original repository and click the "New Pull Request" button. Follow the instructions to create a PR, describing your changes and their purpose.

  2. Review and Collaboration: Your PR will be reviewed by the project maintainers and other contributors. Be prepared to address any feedback and make necessary changes.

  3. Merging: Once your PR is approved, it will be merged into the main project. Congratulations, you've successfully contributed to Meteor!

Reporting Issues

If you encounter any issues or have suggestions for improvements, please feel free to create an issue. Make sure to provide as much detail as possible to help us understand and address the problem.

Code Style Guidelines

  • Follow the established coding style and conventions used in the project. If there are specific style guides, they will be documented in the project's documentation or in a separate file.

Licensing

By contributing to Meteor, you agree that your contributions will be licensed under the project's LICENSE.

Thank You

Your contributions are greatly appreciated! We couldn't do it without you. Thank you for being a part of the Meteor community.

If you have any questions or need further assistance, feel free to reach out to us via the project's issue tracker.

Happy contributing! 🚀