Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 3.66 KB
Raw

Hacktoberfest 2020 Testing Contributions guidlines :octocat: :

Hacktoberfest 2020

Hi there! Welcome to Node Testing for Hacktoberfest!

All contribution is welcome (adding features✨, bug fix🔧, bug report🐛, upload projects📱, design✒️, documentation📝, fixing typos ...etc). but prefered quality over quantity so avoid making small PRs to fix small areas of code.

Event Details:

Hacktoberfest® is open to everyone in the global community. Whether you’re a developer, student learning to code, event host, or company of any size, you can help drive growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to complete the challenge.

  • You can sign up anytime between October 1 and October 31. Just be sure to sign up on the official Hacktoberfest website for your pull requests to count.
  • Hacktoberfest is a celebration open to everyone in the global community.
  • Pull requests can be made in any GitHub-hosted repositories/projects.
  • You can sign up anytime between October 1 and October 31.

To contribute to this repo, please make sure to follow the rules.

Rules:

  • Make sure to sign up first to the event website using your GitHub account: https://hacktoberfest.digitalocean.com/ so your contribution counts in the event.
  • Check the List of Challenges if you don't know what to contribute to.
  • Translations should be in their own dedicated folder, at the root /translations
  • All unit or integration tests should go into the /tests folder inside their dedicated topic folder
  • Always check repo's open issues to avoid duplicates, conflict and ambigous work.
  • Always open an issue stating the subject of your upcoming contribution (if it is significant one).
  • Always assign yourself to an issue by commenting "taken" before starting to work on it.
  • Open a pull request to add tests, fix bugs, add features, enhance documentation ...
  • Always make sure to write a proper explanation in your pull request.
  • Always make sure your own forked repo is updated to the latest version of the original repo before you make a contribution (It is done by a PR from original repo, to your fork) as it is often updated.
  • If the PR doesn't align with the event and/or the repo's rules then you'll be asked to make changes, otherwise it will be marked as invalid. ❌ and won't count in the challenge.

Please:

  • DO NOT submit random Pull Requests. Always refer to issues, it may already exists for the bugs you found or features you want to add or someone else is already working on it.

Pull Requests

  • Fork this original repo to your own account.
  • Work in browser or clone it locally on your machine.
  • Create a new branch for you contribution and name it relatively (e.g: git branch user-tests or fix-project_name-issue)
  • Document your code, no one has time to figure out the meaning of your ancient rituals codes ...
  • Make sure your contribution don't break existing features.
  • A PR clear discription and meaningful title of your contribution are requested.
  • Link the issue(s) you worked on in your pull request description.

Issues

  • Issues are labbeled to make it easier for contributors/mantainers identify them.
  • Always check the existing issues to avoid conflict and duplicates.
  • Request to be assigned to an issue before you start working on it.

NOTE:

Contributions to this project are released to the public under the project's open source license.

Happy hacking!