Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.7 KB

CONTRIBUTE.md

File metadata and controls

51 lines (37 loc) · 1.7 KB

Contribution

if you want to contribute to the repo-reporter project, this contributing guide is helpful.

!Badge Theme

If you are good at working with SVGs, please help us to extend our theme library. You can join our discord server to discuss more about ideas.

start contributing

We use GitFlow for branching model on this project. You must have git-flow installed on your machine.

To start contributing on repo-reporter:

  • Fork repo-reporter's repo
  • Clone your fork
  • Start your feature branch by git flow feature start <feature_name> command
  • Create your changes and commits
  • Push your feature branch
  • Create pull request
git clone <your-fork-repo-url>
cd repo-reporter
git flow feature start <feature_name>
// Create your changes and commits
git push origin feature/<feature_name>

and then make pull request.

Idea

if you haven't any idea for contributing, you can see Issues or TODO.md.

Documentation

If you are adding/changing a feature, add/change documentation of that feature.

For example, If you are adding a new feature, add documentation for that in doc/<Directory To That Feature>/<x>.md.

Release Notes

Write your changes into the RELEASE-NOTES.md file.

For example:

## next release
- ... (Someone's name)
- ... (Someone's name)
- Fixed bug X (Your name)
- Added X (Your name)