-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
created a contributing.md file and made QRCodeDisplay as a server com…
…ponent
- Loading branch information
1 parent
f4dd3e1
commit ef27e93
Showing
3 changed files
with
49 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"react-daraja": patch | ||
--- | ||
|
||
made QRCodeDisplay a server component and created a contributing.md file |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing to React Daraja | ||
|
||
Welcome to React Daraja! We're excited that you're interested in contributing. Before you start, please follow the guidelines below. | ||
|
||
## How to Contribute | ||
|
||
We use [changesets](https://github.com/atlassian/changesets) to manage releases and versioning. Follow the three-step process below to contribute: | ||
|
||
### Step 1: Make Changes | ||
|
||
Make your code changes or additions in your local repository. Before committing your changes, run the following command: | ||
|
||
```bash | ||
npx changeset | ||
|
||
``` | ||
|
||
This command will prompt you to select the type of change you are making (patch, minor, major), and it will create a changeset file. | ||
|
||
Although its not mandatory, you only run the command if you feel your changes are ready to be pushed to NPM or if its a critical bug that the users of the lib need in their code ASAP. | ||
|
||
### Step 2: Fill out the Changeset | ||
|
||
Navigate to the .changeset directory and open the generated changeset file. Fill out the details of your changes, including a description of the modifications you made. | ||
|
||
### Step 3: Commit and Push | ||
|
||
Commit your changes and the generated changeset file. Push your changes to your fork or branch. When your pull request is merged, the changeset will be used to create a release. | ||
|
||
## Releasing Changes | ||
|
||
Changesets help manage versioning and releases. Whenever you commit the generated changesets file, Github Actions automatically pushes the new package version to NPM. | ||
|
||
Thank you for contributing to React Daraja! 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters