shanec/forgejo-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions
forgejo-sdk/CONTRIBUTING.md
Martijn van der Kleijn f4c493667c Make final corrections before fork is finalized (#3) 
Reviewed-on: https://codeberg.org/mvdkleijn/forgejo-sdk/pulls/3
Co-authored-by: Martijn van der Kleijn <martijn.niji@gmail.com>
Co-committed-by: Martijn van der Kleijn <martijn.niji@gmail.com>
2024-05-03 14:54:54 +00:00

2.8 KiB
Raw Permalink Blame History

Contribution Guidelines

Bug reports

Please search the issues on the issue tracker with a variety of keywords to ensure your bug is not already reported.

If unique, open an issue and answer the questions so we can understand and reproduce the problematic behavior.

To show us that the issue you are having is in Forgejo SDK itself, please write clear, concise instructions so we can reproduce the behavior (even if it seems obvious). The more detailed and specific you are, the faster we can fix the issue.

Please be kind, remember that Forgejo SDK comes at no cost to you, and you're getting free help.

Discuss your design

The project welcomes submissions but please let everyone know what you're working on if you want to change or add something to the Forgejo SDK repository.

Before starting to write something new for the Forgejo SDK project, please file an issue.

Testing redux

Before sending code out for review, run all the tests using make test, to make sure the changes don't break other usage. In order to run the test, you'll need a test instance. You can create one using make test-instance.

Code review

Changes must be reviewed before they are accepted, no matter who makes the change even if it is an owner or a maintainer.

Please try to make your pull request easy to review for us. Some of the key points:

  • Make small pull requests. The smaller, the faster to review and the more likely it will be merged soon.
  • Don't make changes unrelated to your PR. Maybe there are typos on some comments, maybe refactoring would be welcome on a function... but if that is not related to your PR, please make another PR for that.
  • Split big pull requests into multiple small ones. An incremental change will be faster to review than a huge PR.

Sign your work

The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: If you can certify DCO, then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Please use your real name. If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

Copyright

Code that you contribute should use the standard copyright header:

// Copyright 2024 The Forgejo Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

Files in the repository contain copyright from the year they are added to the year they are last changed. If the copyright author is changed, just paste the header below the old one.