Skip to content

Latest commit

 

History

History
124 lines (102 loc) · 5.92 KB

CONTRIBUTING.md

File metadata and controls

124 lines (102 loc) · 5.92 KB
Raw

Contributing to Pubs ERP

Looking to contribute something to Pubs ERP?

Here's to how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is the preferred channel for bug reports and features requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.
  • Please do not derail or troll issues. Keep the discussion on the topic and respect the opinions of others.

Issues and labels

Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:

  • bug - Something isn't working
  • duplicate - This issue or pull request already exists
  • enhancement - New feature or request
  • good - first issue Good for newcomers
  • help - wanted Extra attention is needed
  • invalid - This doesn't seem right
  • question - Further information is requested
  • wontfix - This will not be worked on

For a complete look at our labels, see the Pubs ERP labels page.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  • Validate your code — To ensure your problem isn't caused by a simple error in your own code.
  • Use the GitHub issue search — Check if the issue has already been reported.
  • Check if the issue has been fixed — Try to reproduce it using the latest master or development branch in the repository.

A good bug report shouldn't leave contributors needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What platform(s) experience the problem? Do other platform(s) show the bug differently? What would you expect to be the outcome? All these details will help fix any potential bugs.

Example:

Describe a clear and concise description of what the bug is.

Provide steps to reproduce the behavior.

Provide a clear and concise description of what you expected to happen.

If applicable, add screen-shots to help explain your problem.

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests — patches, improvements, new features — are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding guidelines and use them throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Be carefull when editing the master branch directly! Significantly, always try to make pull requests and work from a branch.

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/pubs_erp.git
# Navigate to the newly cloned directory
cd pubs_erp
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/capslockcoders/pubs_erp.git

  2. If you cloned a while ago, get the latest changes from master:

    git checkout master
git pull upstream master

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull --rebase upstream master

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description against the master branch.

License

By contributing your code, you agree to license your contribution under the MIT License. By contributing to the documentation, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.