First off, thanks for taking the time to contribute! 🎉👍
There are many ways to contribute to Marcelle, and many of them do not involve writing any code. Here's a few ideas to get started:
- Simply start using Marcelle. Go through the Getting Started guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
- Share your projects and writings, for example using the "Show and Tell" category on Github Discussions.
- If you create new components, share them as a third party library on npm
- Look through the open issues. A good starting point would be issues tagged good first issue. Provide workarounds, ask for clarification, or suggest labels.
- If you find an issue you would like to fix, open a pull request.
- Read through our documentation. If you find anything that is confusing or can be improved, you can make edits in the repository.
Contributions are very welcome. If you think you need help planning your contribution, please use Github Discussions and let us know you are looking for a bit of help.
If you have questions about using Marcelle, please use Github Discussions instead of opening an issue and we will do our best to answer your questions.
We use GitHub issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. When opening a new issue, always make sure to fill out the issue template.
- One issue, one bug: Please report a single bug per issue.
- Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.
If you see anything you'd like to be implemented, create a feature request issue
Marcelle can be extended with custom components. While a few components are available within the core library, it is perfectly possible to share components or component libraries publicly. You can publish a package on NPM containaining ore of several components for others to reuse.
If you believe that a component belongs in the core library, feel free to open a pull request or a feature request issue.
So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.
If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with feature template.
If you're only fixing a bug, it's fine to submit a pull request right away, but we still recommend that you file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.
Please make sure the following is done when submitting a pull request:
- Fork the repository and create your branch from
master. - Describe your test plan in your pull request description. Make sure to test your changes.
All pull requests should be opened against the master branch.
The core Svelte team will be monitoring for pull requests. Do help us by making your pull request easy to review by following the guidelines above.
Please configure your editor to use Eslint and Prettier, for which configuration files are provided.
The Open Source Guides website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful:
Working on your first Pull Request? You can learn how from this free video series:
How to Contribute to an Open Source Project on GitHub
By contributing to Marcelle, you agree that your contributions will be licensed under its MIT license.