Skip to content

Commit

Permalink
Merge pull request #3 from pixelib/feature/contributing
Browse files Browse the repository at this point in the history
Add CONTRIBUTING.MD
  • Loading branch information
Duckelekuuk authored Oct 5, 2023
2 parents 33ce97e + 87296e0 commit 4d4ab17
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 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:

```bash
git clone https://github.com/pixelib/Meteor.git
```
3. **Create a Branch**: Create a new branch for your contributions, where `[branch-name]` is a descriptive name for your branch:

```bash
git checkout -b [branch-name]
```

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

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

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

```bash
git commit -m "Your descriptive commit message here"
```

7. **Push Your Changes**: Push your changes to your forked repository on GitHub:

```bash
git push origin [branch-name]
```

8. **Create a Pull Request (PR)**: Go to the [original repository](https://github.com/pixelib/Meteor.git) and click the "New Pull Request" button. Follow the instructions to create a PR, describing your changes and their purpose.

9. **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.

10. **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](https://github.com/pixelib/Meteor/issues). 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](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! 🚀

0 comments on commit 4d4ab17

Please sign in to comment.