First, thank you for considering contributing to Ts.ED! It is people like you that make the open source community such a great community! 😊
We welcome any type of contribution, not just code. You can help with:
- QA: file bug reports, the more details you can give the better (e.g. screenshots with the console open).
- Marketing: writing blog posts, how to's, printing stickers....
- Community: presenting the project at meetups, organizing a dedicated meetup for the local community....
- Code: take a look at the open issues. Even if you can't write code, commenting on them and showing that you care about a given issue matters. It helps us triage them.
- Money: we welcome financial contributions in full transparency on our open collective.
# Your First Contribution
Working on your first Pull Request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.
# Submitting code
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
Ts.ED project uses conventional commits as format commit message.
Release note and tagging version are based on the message commits. If you don't follow the format, our CI won't be able to increment the version correctly and your feature won't be released on NPM.
To write your commit message, see convention page here
# Financial contributions
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors, and the person who filed the expense will be reimbursed.
If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at firstname.lastname@example.org.
# How to work on Ts.ED
Clone your fork of the repository:
$ git clone https://github.com/YOUR_USERNAME/tsed.git
Install npm dependencies with yarn (not with NPM!):
After installing dependencies, yarn/npm run the
postinstallhook and mount all packages with
yarn run repo:bootstrap).
tsc # or yarn tsc # or npm run tsc
yarn test # or npm run test
# Gflow (optional)
Gflow is a command line tool to help developers with the Git process used in Ts.ED.
Gflow helps you create a branch from production, rebase and run the tests before pushing your branch on your remote repository.
npm install -g gflow
# Start a feature branch
git fetch git branch --no-track -b feat-branch-name origin/production # !IMPORTANT yarn ## OR gflow new feat name_of_feat
# Commit & Push a feature
This command rebases your branch feature from the production branch, runs the test, and pushes your branch.
git commit -m "feat(domain): Your message"
To write your commit message see convention page.
npm run test git fetch git rebase origin/production git push -f # OR using gflow (run fetch, rebase and push for you) gflow push
When your feature is ready to review, you can open a PR on Ts.ED github.
# Finish a feature (repo owner and maintainers)
After the PR has been accepted, the feature will be automatically merged on the master branch, but your feature isn't merged with the production branch.
To publish your feature on the production branch you need to run this command:
This action works only on the Ts.ED repository (not on your fork).
# Write documentation
Ts.ED uses docsify to convert markdown to HTML. In addition, all documentation in your code will be used to generate the API documentation. To preview your comments on a class you can run this command:
npm run doc:serve
- Ts.ED follows the git flow to generate a release note. To write your commit message see convention page.
- Please try to combine multiple commits before pushing.
- Please use TDD when fixing bugs. This means that you should write a unit test that fails because it reproduces the issue, fixes the issue, and then finally runs the test to ensure that the issue has been resolved. This helps us prevent fixed bugs from happening again in the future.
- Please keep the test coverage at 100%. Write additional unit tests if necessary.
- Please create an issue before sending a PR if it is going to change the public interface of Ts.ED or include significant architecture changes.
- Feel free to ask for help from other members of the Ts.ED team.