Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.44 KB
Raw

Contributing

♥ TinyLink and want to get involved?
Thanks! There are plenty of ways you can help!

Report issues

Check project and report your issue here

  1. Report your Idea
    If you have a any idea about design, programming, technology and other, please open an issue.

  2. Ask any question
    You can ask any question about this projects and codes

  3. Bug report
    Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to assess and fix any potential bugs.

Pull requests

Good pull requests — patches, improvements, new features — are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first.

Please follow this process; it's the best way to get your work included in the project:

  1. Fork the project.

  2. Clone your fork (git clone https://github.com/<your-username>/tinylink.git).

  3. Add an upstream remote (git remote add upstream https://github.com/NazarkinRoman/tinylink.git).

  4. Get the latest changes from upstream (e.g. git pull upstream <dev-branch>).

  5. Create a new topic branch to contain your feature, change, or fix (git checkout -b <topic-branch-name>).

  6. Make sure that your changes adhere to the current coding conventions used throughout the project - indentation, accurate comments, etc. Please update any documentation that is relevant to the change you are making.

  7. Commit your changes in logical chunks; use git's interactive rebase feature to tidy up your commits before making them public. Please adhere to these git commit message guidelines or your pull request is unlikely be merged into the main project.

  8. Locally merge (or rebase) the upstream branch into your topic branch.

  9. Push your topic branch up to your fork (git push origin <topic-branch-name>).

  10. Open a Pull Request with a clear title and description. Please mention which browsers you tested in.