Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution guide #54

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Contributing to Mpesa-node-library

Thank you for showing interest in contributing to Mpesa-node-library. We welcome all contributions. There is more to one way of contribution and we are open to all the suggestions as they are highly appreciated.




## What to do and How to get started.
Follow the to get the complete guide.


## Guidelines for Reporting Issues and Suggestions

## Follow the Guide:

1. Please refer to the [README.md] (/README.md) for detailed instructions.

2. Search for Existing Issues:

- If you encounter a bug, want to suggest a feature, or have a question, first [search the issue tracker] (https://github.com/safaricom/mpesa-node-library/issues) to check if someone has already created a ticket for it.

3. Create a New Issue:

- If no ticket exists, feel free to [create one] (https://github.com/safaricom/mpesa-node-library/issues/new/).
- Assign the issue to yourself or another developer.
- Assign the issue to the relevant project.
- Add appropriate tags to clarify the issue.


## Submission Guidelines

1. Submitting an Issue
- Ensure you followed the above guide while creating the issue
- Include Screenshots if any at any point

## Pull Request(PR) submission

1. Choose a descriptive branch name - It should be like issue-1800 if your are working on issue number 1800.

2. Create a branch name -
`git checkout -b my-new-feature`

3. Make commit to your feature branch- Each commit should be self-contained and have a descriptive commit message, helping other developers understand why the changes were made.

Commit your changes: `git commit -m 'Add some feature'`

- When sending PR then it should notify which issue you are solving. Like this BranchName: Fix #issuedetail - description

- For example Fix #1245 - Issue Description

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

6. Ensure that the code you write is well-tested.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,10 @@ new Mpesa({
- [x] More detailed Unit tests
- [ ] Handle all Promises

## Contributing
1. Create your feature branch: `git checkout -b my-new-feature`
2. Commit your changes: `git commit -m 'Add some feature'`
3. Push to the branch: `git push origin my-new-feature`
4. Submit a pull request :D
## Contribution

- Refer to the [CONTRIBUTING GUIDE](/CONTRIBUTING.md).


## Credits

Expand Down