Hey, I will give you format just write rest of the content.
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 have to get a development env 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
- Hat tip to anyone who's code was used
- Inspiration
- etc
And also you can add contribute.md file which is written in markdown languga.
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.
Using the issue tracker
First things first: Do NOT report security vulnerabilities in public issues! Please disclose responsibly by letting [ this project team](mail to:team@thethis projectfirm.com?subject=Security) know upfront. We will assess the issue as soon as possible on a best-effort basis and will give you an estimate for when we have a fix and release available for an eventual public disclosure.
The issue tracker is the preferred channel for bug reports,
features requests and submitting pull
requests, but please respect the following restrictions:
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: 😄 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 directory
cd <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.
-
Push your topic branch up to your fork:
git push origin <topic-branch-name>
-
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
git clone https://github.com/this projecthq/<repo-name>
cd <repo-name>
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.
-
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
Afterwards 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:
Commit Message Conventions
- Commit test files with
test: ... or test(scope): ... prefix
- Commit bug fixes with
fix: ... or fix(scope): ... prefix
- Commit breaking changes by adding
BREAKING CHANGE: in the commit body
(not the subject line)
- Commit changes to
package.json, .gitignore and other meta files with
chore(filenamewithoutext): ...
- Commit changes to README files or comments with
docs: ...
- Cody style changes with
style: standard
IMPORTANT: By submitting a patch, you agree to license your work under the
same license as that used by the project.
Triagers
There is a defined process to manage issues, because this helps to speed up releases and minimizes user pain.
Triaging is a great way to contribute to this project without having to write code.
If you are interested, please [leave a comment here](https://github.com/this projecthq/discussion/issues/50) asking to join the triaging team.
Maintainers
If you have commit access, please follow this process for merging patches and cutting new releases.
Reviewing changes
-
Check that a change is within the scope and philosophy of the component.
-
Check that a change has any necessary tests.
-
Check that a change has any necessary documentation.
-
If there is anything you don’t like, leave a comment below the respective
lines and submit a "Request changes" review. Repeat until everything has
been addressed.
-
If you are not sure about something, mention @this project/maintainers or specific
people for help in a comment.
-
If there is only a tiny change left before you can merge it and you think
it’s best to fix it yourself, you can directly commit to the author’s fork.
Leave a comment about it so the author and others will know.
-
Once everything looks good, add an "Approve" review. Don’t forget to say
something nice 👏🐶💖✨
-
If the commit messages follow our conventions
- If there is a breaking change, make sure that
BREAKING CHANGE: with
exactly that spelling (incl. the ":") is in body of the according
commit message. This is very important, better look twice :)
- Make sure there are
fix: ... or feat: ... commits depending on wether
a bug was fixed or a feature was added. Gotcha: look for spaces before
the prefixes of fix: and feat:, these get ignored by semantic-release.
- Use the "Rebase and merge" button to merge the pull request.
- Done! You are awesome! Thanks so much for your help 🤗
-
If the commit messages do not follow our conventions
- Use the "squash and merge" button to clean up the commits and merge at
the same time: ✨🎩
- Is there a breaking change? Describe it in the commit body. Start with
exactly BREAKING CHANGE: followed by an empty line. For the commit
subject:
- Was a new feature added? Use
feat: ... prefix in the commit subject
- Was a bug fixed? Use
fix: ... in the commit subject
Sometimes there might be a good reason to merge changes locally. The process
looks like this:
Reviewing and merging changes locally
git checkout master # or the main branch configured on github
git pull # get latest changes
git checkout feature-branch # replace name with your branch
git rebase master
git checkout master
git merge feature-branch # replace name with your branch
git push
When merging PRs from forked repositories, we recommend you install the
hub command line tools.
This allows you to do:
hub checkout link-to-pull-request
meaning that you will automatically check out the branch for the pull request,
without needing any other steps like setting git upstreams! ✨
Issues
Issue open :
It is not just like fun and You need also post a valid post with the opening Issue.
Closing Issue:
Actully this is also follow same above and It will need to more percise to resolve the problem and test yourself and then you can close.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent