You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These instructions will get you a copy of the project up and run on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them
Give examples
Installing
A step by step series of examples that tell you to have to get a development end running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Running the tests
Explain how to run the automated tests for this system
Break down into end to end tests
Explain what these tests test and why
Give an example
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
Hat tip to anyone who's code was used
Inspiration
etc
And also you can add contribute.md file which is written in markdown language.
Contributing to the project
Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue, assessing
changes, and helping you finalize your pull requests.
As for everything else in the project, the contributions to this project are governed by our team.
Bug reports
A bug is a demonstrable problem that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
Use the GitHub issue search — check if the issue has already been
reported.
Check if the issue has been fixed — try to reproduce it using the
latest master or next branch in the repository.
Isolate the problem — ideally, create a reduced test case.
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What OS experiences the
problem? What would you expect to be the outcome? All these details will help
people to fix any potential bugs.
Example:
Short and descriptive example bug report title
A summary of the issue and the browser/OS environment in which it occurs. If
suitable, include the steps required to reproduce the bug.
This is the first step
This is the second step
Further steps, etc.
<url> - a link to the reduced test case
Any other information you want to share that is relevant to the issue being
reported. This might include the lines of code that you have identified as
causing the bug, and potential solutions (and your opinions on their
merits).
Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to you to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
Pull requests
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
Please ask first before embarking on any significant pull request (e.g.
implementing features, refactoring code), otherwise you risk spending a lot of
time working on something that the project's developers might not want to merge
into the project.
For new Contributors
If you never created a pull request before, welcome: tada: : smile: Here is a great tutorial
on how to send one :)
Fork the project, clone your fork,
and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name># Navigate to the newly cloned directorycd<repo-name># Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/this projecthq/<repo-name>
If you cloned a while ago, get the latest changes from upstream:
git checkout master
git pull upstream master
Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:
git checkout -b <topic-branch-name>
Make sure to update, or add to the tests when appropriate. Patches and
features will not be accepted without tests. Run npm test to check that all
tests pass after you've made changes. Look for a Testing section in the
project’s README for more information.
If you added or changed a feature, make sure to document it accordingly in
the README.md file.
Make sure to update, or add to the tests when appropriate. Patches and
features will not be accepted without tests. Run npm test to check that all tests
pass after you've made changes. Look for a Testing section in
the project’s README for more information.
If you added or changed a feature, make sure to document it accordingly in
the README.md file.
Push your topic branch up to our repo
git push origin <topic-branch-name>
Open a Pull Request using your branch with a clear title and description.
Optionally, you can help us with these things. But don’t worry if they are too
complicated, we can help you out and teach you as we go :)
Update your branch to the latest changes in the upstream master branch. You
can do that locally with
git pull --rebase upstream master
Afterward, force push your changes to your remote feature branch.
Once a pull request is good to go, you can tidy up your commit messages using
Git's interactive rebase.
Please follow our commit message conventions shown below, as they are used by semantic-release to automatically
determine the new version and release to npm. In a nutshell:
Issues
Issue open :
It is not just fun.If there is really the bug or issue or suggestion the create an issue or make a pull request.
The text was updated successfully, but these errors were encountered:
Project Title
One Paragraph of project description goes here
Getting Started
These instructions will get you a copy of the project up and run on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them
Installing
A step by step series of examples that tell you to have to get a development end running
Say what the step will be
And repeat
End with an example of getting some data out of the system or using it for a little demo
Running the tests
Explain how to run the automated tests for this system
Break down into end to end tests
Explain what these tests test and why
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
And also you can add contribute.md file which is written in markdown language.
Contributing to the project
Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue, assessing
changes, and helping you finalize your pull requests.
As for everything else in the project, the contributions to this project are governed by our team.
Bug reports
A bug is a demonstrable problem that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
Use the GitHub issue search — check if the issue has already been
reported.
Check if the issue has been fixed — try to reproduce it using the
latest
master
ornext
branch in the repository.Isolate the problem — ideally, create a reduced test case.
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What OS experiences the
problem? What would you expect to be the outcome? All these details will help
people to fix any potential bugs.
Example:
Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to you to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
Pull requests
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
Please ask first before embarking on any significant pull request (e.g.
implementing features, refactoring code), otherwise you risk spending a lot of
time working on something that the project's developers might not want to merge
into the project.
For new Contributors
If you never created a pull request before, welcome: tada: : smile: Here is a great tutorial
on how to send one :)
Fork the project, clone your fork,
and configure the remotes:
If you cloned a while ago, get the latest changes from upstream:
Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:
Make sure to update, or add to the tests when appropriate. Patches and
features will not be accepted without tests. Run
npm test
to check that alltests pass after you've made changes. Look for a
Testing
section in theproject’s README for more information.
If you added or changed a feature, make sure to document it accordingly in
the
README.md
file.Push your topic branch up to your fork:
Open a Pull Request
with a clear title and description.
For Members of the this project Contributors Team
Clone the repo and create a branch
Make sure to update, or add to the tests when appropriate. Patches and
features will not be accepted without tests. Run
npm test
to check that all testspass after you've made changes. Look for a
Testing
section inthe project’s README for more information.
If you added or changed a feature, make sure to document it accordingly in
the
README.md
file.Push your topic branch up to our repo
Open a Pull Request using your branch with a clear title and description.
Optionally, you can help us with these things. But don’t worry if they are too
complicated, we can help you out and teach you as we go :)
Update your branch to the latest changes in the upstream master branch. You
can do that locally with
Afterward, force push your changes to your remote feature branch.
Once a pull request is good to go, you can tidy up your commit messages using
Git's interactive rebase.
Please follow our commit message conventions shown below, as they are used by
semantic-release to automatically
determine the new version and release to npm. In a nutshell:
Issues
Issue open :
It is not just fun.If there is really the bug or issue or suggestion the create an issue or make a pull request.
The text was updated successfully, but these errors were encountered: