Welcome to the contributing file of English Is Fun project!
First of all, thank you so much for thinking about contributing to this project, all kinds of contributions are welcomed whether they are through bug reports or pull requests.
Please add an issue. We will review it, add some labels and reply you within a few days with some feedback.
Add a comment on the issue that you would like to work on and we will add the 🙋♂️claimed
label.
If you see the 🙋♂️claimed
label already on the issue you might want to ask the contributor if they would like some help.
Feel free to add an issue using the 📚 Documentation request
template or submit a pull request when you are done.
We love pull requests from everyone, just fork the project and start working on whatever you like the most.
All changes should be based from the master
branch. Push to your fork and submit a pull request against the master
branch.
At this point you are waiting on us. We may suggest some changes or improvements or alternatives.
Some things that will increase the chances that your pull request is accepted:
- Make sure all tests and lint checks are passing (review them on the pull request page)
- Update the README with any changes that are needed
- Write tests (if needed)
- Write a good commit message