Skip to content

Commit

Permalink
[chore] Add Contribution Docs (#32)
Browse files Browse the repository at this point in the history
* add contributing

* fix
  • Loading branch information
warittornc authored Apr 30, 2024
1 parent 70e88d2 commit 99348f4
Showing 1 changed file with 42 additions and 12 deletions.
54 changes: 42 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,53 @@
# Contributing
# Contributing to Bothan

Thank you for your interest in contributing! You can contribute to `band-price-adapter` in many ways.
A big welcome and thank you for considering contributing to Bothan!
Reading and following these guidelines will help us make the contribution process easy and effective for everyone
involved. It also communicates that you agree to respect the time of the developers managing and developing these
open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes,
and helping you finalize your pull requests.

1. **Issues**
## Quicklinks

If you find any bug/issues with the `band-price-adapter` from any perspective (document/function/usage), you can always open the [issue](https://github.com/bandprotocol/band-price-adapter/issues/new/choose) in GitHub to tell us.
* [Getting Started](#getting-started)
* [Issues](#issues)
* [Pull Requests](#pull-requests)

2. **Discussion**
## Getting Started

If you have any idea on how to improve and want to discuss your idea with our community. We also open [a discussion board](https://github.com/bandprotocol/band-price-adapter/discussions) for it.
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

3. **Pull requests**
- Search for existing Issues and PRs before creating your own.
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while
to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw
attention if your issue is blocking.

In case, you want to add more features that you think will improve developer experiences. You can open the [pull request](https://github.com/bandprotocol/band-price-adapter/pulls) to our main branch.
### Issues

4. **Forking**
Issues should be used to report problems, request a new feature, or to discuss potential changes before a PR is created.
When you create a new issue. If you find an Issue that addresses the problem you're having, please add your own
reproduction information to the existing issue rather than creating a new one. Adding a
[reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help indicate
to our maintainers that a particular problem is affecting more than just the reporter.

We also welcome you to fork our repository to either do a pull request or create your version.
### Pull Requests

5. **Star**
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next
release. In general, PRs should:

If you like or use our work, you can also give a star to our repository.
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- Add unit or integration tests for fixed or changed functionality.
- Address a single concern in the least number of changed lines as possible.
- Be accompanied by a complete Pull Request template.

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open
an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)

1. Fork the repository to your own GitHub account
2. Clone the project to your machine
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Following any formatting and testing guidelines specific to this repo
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

0 comments on commit 99348f4

Please sign in to comment.