Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

24 lines (21 loc) · 1.69 KB
Raw

How to contribute ?

Contribute by testing Tulipe

  1. Test the library's features
  2. Observe a bug or an improvement that could be made
  3. Report it by creating an issue

Contribute by coding Tulipe

  • If you have found a bug or a potential improvement for the library and want to code it, we would be happy to accept your PRs! Important : It'd be good to talk about it beforehand to make sure that no one else is working on it. You can open an issue for this.
  • If you want to code but don't know where to start :
    1. Check out the issues labelled "help wanted".
    2. Check out our roadmap and choose an unassigned task

Here are the steps to contribute to the Tulipe's code :

  1. Fork this repository
  2. Clone your fork on your computer using git clone https://github.com/<YourGithubName>/tulipe.git
  3. In local, navigate into the cloned folder called tulipe/
  4. Add the Tulipe project repository as the "upstream" remote using git remote add upstream https://github.com/LilaRest/tulipe.git
  5. Now you can easily pull the new updates on the Tulipe repository using git pull upstream main
  6. Apply changes in your local repository
  7. Commit your changes using git add -A + git commit -m "<YourChangesDescription>"
  8. Push your changes to your fork repository using git push origin main
  9. Return to your fork on Github, refresh the page and you should see an highlighted area that invites you to initiate a Pull Request. (alternatively you can click on the "New pull request" button)