Skip to content

Latest commit

 

History

History
46 lines (24 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

46 lines (24 loc) · 4.06 KB
Raw

Contribution Etiquette

Open Source projects function most efficiently when everyone communicates well with each other. Here are some suggested practices that will let everyone else work alongside you comfortably:

Did you find a bug? Do you want to suggest an enhancement?

  • Ensure your contribution is novel by searching the Issues page. Be sure to look through both open and closed issues, especially for enhancement suggestions as rejected suggestions will be closed.

  • If applicable use the appropriate issue templates to automatically apply the relevant tag to the created issue. This allows issues to be quickly differentiated as bug reports, enhancement suggestions, or whatever else without a maintainer manually adding the tag to the issue. The bug report template will specify which information to add that will aid in reproducing the bug.

  • Inconsequential fixes regarding typos, whitespace, etc. may not warrant an issue and can skip straight to the Pull Request.

Do you want to fix a currently existing issue?

  • Before working on an issue please honor issue assignments and ask to be assigned to the issue in a comment on the issue page. This allows everyone else to see that someone is working on the issue preventing any duplicate pull requests down the line. If someone is already assigned to the issue feel free to reach out to the assignee and inquire on the progress of that fix.

  • While working on an issue document your changes by providing detailed commit messages and providing an overview of planned / current implementation / changes on the issue page.

  • When you feel your fork adequately fixes an issue, submit a pull request for review! Please indicate which issue is to be closed if the PR is merged as well as giving a detailed overview of your changes.

  • Please limit the content of your pull requests to its linked issues. If your pull request does anything additional you must first open an issue that your PR may close (see the below section).

Do you intend to add a new feature or change an existing one?

  • Please open an issue to generate feedback on the change first. The maintainers reserve the right to reject changes / additions that they do not want to maintain, so be sure that the maintainers are on the same page as you to avoid wasted work!

  • Now that an issue covers the changes you wanted to make refer to the above section for implementing the changes.

Do you want to submit/update a translation?

  • Submit a pull request with your new / updated JSON file in the lang folder.

  • Be sure that the JSON file is either completely flat or completely nested.

  • If your localization does not include translations for any strings please indicate as much in the lang / missing folder.

Do you want to contribute documentation?

  • Please follow the above guidelines regarding opening issues and submitting pull requests. Some documentation issues may be broader and ongoing, in which case you may want to contribute to assignee's forks first. Any smaller changes should still open a detailed issue and submit a detailed pull request that closes that issue.

Do you have questions about the source code?

  • Join the TyphonJS Discord and direct questions to the appropriate channel (#forien-quest-log).

  • Please do not directly contact maintainers with questions; if you have a question other people might as well, so discussions should take place in public forums where others can see and learn from it as well.

Thank you for your interest in contributing to Forien's Quest Log! ❤️