Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 3.09 KB

elkarte.net site repository

Elkarte is licensed under BSD 3-clause license.

Documentation is licensed under CC-by-SA 3.

Third party libraries or sets of images, are under their own licenses.

Notes:

Feel free to fork this repository and make your desired changes.

Please see the Developer's Certificate of Origin in the repository: by signing off your contributions, you acknowledge that you can and do license your submissions under the license of the project.

How to Contribute:

  • Fork the repository. If you are not used to using Github, please check out fork a repository.
  • Branch your own repository. Example:
git checkout -b new_enhancement_name
  • Please do not commit to your 'master' branch, or branch off and cherry-pick commits before sending in a PR.
  • Commit the desired changes to that branch. As many commits on 'new_enhancement' as you want.
    • Granular commits are not a problem.
    • Please try to add only commits related to the respective feature/fix to a branch.
    • If you need to commit something unrelated, create another branch for that topic.
  • Sign-off on your commits, to acknowledge your submission under the license of the project.
    • See the DCO document from the top directory.
  • Send in a pull request (PR) from your new_enhancement_name branch.
  • If the main repository has been updated in the meantime, you can pull the changes in your repository:
    • to pull in from master to your master branch: git pull --rebase upstream master (please replace 'upstream' to the name of your remote for the main repository)
    • to merge after you have updated your master, to your new_enhancement branch:
      • git rebase master
      • alternatively: git merge master (this may create a merge commit by default)

Details about the rebase operation: [git rebase] (http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html)

Recommended reading for github pull requests workflow: About Github workflow

Code Reviews

An important and very helpful part of the workflow is code reviews.

The more eyes are on the code, on the PRs, the better: one can always spot something missed, a small detail, a serious bug, or start a conversation on the code that will help in the end reach a better solution for the software.

Code reviews can be made from the github web interface, or by checking out of the code pulled in locally. You can also test the PRs. Please do, express your objections or approval, fix things or report them.

Developer Documentation

ElkArte coding standards documentation: Coding standards

ElkArte architecture documentation: Architecture

Each is work in progress, and welcomes your comments and corrections.